Introduction
The lookup form configurations control the lookup form’s behavior in the application.
Prerequisites
- The form you need to edit must already exist.
- The GetMaxSearch flag should be set to true in the Settings section
- The Enable Application Shortcuts flag should be set to true in the Settings section.
|
Quick Steps |
| 1 |
Search for and open the lookup form |
| 2 |
Open the Configuration tab |
| 3 |
If desired, update the Details information |
| 4 |
If desired, update the Master Page Details information |
| 5 |
If desired, update the Entity Details information |
| 6 |
If desired, update the Main/Sub Query Details information |
| 7 |
If desired, update the ShortCut keys information |
| 8 |
Save the form |
Detailed Steps
Step 1. Search for and open the lookup form.
Step 2. Open the Configuration tab.
Step 3. If desired, update the Details information.
The Details section properties are:
- Form Name (ID): Programmatic ID of the form. This is not editable from the Details section. You can edit it in the Source tab, but best practice is to keep the ID and title the same.
- Form Title: Text the form displays to users as its name.
- Default Action: Action the form will execute when the user presses the Enter key. The default action for the lookup form is the Search action.
- Device Type: This allows you to choose a type of device on which users can see the form. Options are Desktop and Mobile.
- Master Layout: Predefined layouts that make the app look consistent.
- Max Count: Number of search results the form displays unless a search returns fewer results. The default value for lookup screens is 100.
- Route Name: Text Xelence uses to generate a link to the form.
- Allow Anonymous: If set to True, any user can access this form.
- Mobile Menu: If checked, the form will be added in the mobile menu.
- Active: If checked, the form is available on the application; if not, it isn’t. This is checked by default.
The Details section with an updated Max Count.
Step 4. If desired, update the Master Page Details information.
The Master Page Details section property is:
- Content Placeholder ID: Maps this property to a placeholder property in a master page.
Step 5. If desired, update the Entity Details information.
The Entity Details section properties are:
- Entity: The entity is the source of the attributes and properties the form uses.
- Srv Method: Alternate source of properties the form uses if it does not use an entity. This is a legacy property.
Step 6. If desired, update the Main/Sub Query Details information.
The Main/Sub Query Details section properties are:
- Main Query: By default, the main query is blank. You can select a query defined in the entity if you don’t want to execute the default query on clicking Search. The default query selects all the columns from the main table of the entity associated with the form.
- Sub Query: This query will add an exists clause in the where condition of the main query. The application adds the sub query only when a user enters a search criterion associated with the sub query and clicks Search.
Step 7. If desired, update the ShortCut keys information.
The Shortcut Keys section properties are:
- Button: Specifies the buttons available on the form for which the shortcut keys can be configured.
- Base Key: Modifier key that temporarily modifies the normal action of another key when pressed together. The possible options are Alt and Ctrl.
- Key: Key that executes the Button when pressed in combination with the Base Key. Click the three dots icon to view the default keys or click the Edit icon to create new keys.
Step 8. Save the form.
Then, run the Preview. Xelence displays the form output. You can test your updated settings.
When you have previewed your form, it should look something like this:
What are the improvements over S3 Version 6?
This process is identical. However, additional configuration options are added like content placeholder ID for master page details, device type, default button and route name.
Related Articles
Create a Lookup Form
Lookup Form Configuration Controls
This post is part of the Lookup Form topic. Click here to open the Lookup Form Overview.
#Xelence
#Forms