View Article

Lookup Form Configuration Controls

By Xelence Documentation posted 02-07-2024 16:00

  

Details Section:

Form Name

  • What it does: Identifies the form's programmatic ID.
  • How to use it: Read-only.



Form Title

  • What it does: Text the app displays as the form's name.
  • How to use it: Enter text.



Default Action

  • What it does: Action the app will perform if the user opens the form and presses the Enter key. Options depend on the form's buttons.
  • How to use it: Enter or select the ID of the desired button. If left blank, the app will search as the default action.



Device Type

  • What it does: Identifies the type of device the form will display on.
  • How to use it: Enter or select the desired device. Options are Desktop and Mobile.



Master Layout

  • What it does: Layout the app uses to display the form. Options depend on defined master layouts.
  • How to use it: Enter or select the desired layout.



Max Count

  • What it does: Number of search results the app displays for the form (unless the search returns fewer results). 
  • How to use it: Enter the number. If left blank, the app will display up to 100 results.



Route Name

  • What it does: Text Xelence uses to generate a link to the form.
  • How to use it: Enter text.



Allow Anonymous

  • What it does: Determines which users can access the form.
  • How to use it: Select True to allow any user to access the form.



Auto Search

  • What it does: Determines whether the app opens the form with the default query executed.
  • How to use it: Select the desired option. True means the form opens with the executed query. False means the form opens with no search results (the user must perform a search to see results).



Mobile Menu

  • What it does: Determines whether the form can be opened from the mobile menu.
  • How to use it: Check the checkbox to add the form to the mobile menu. Otherwise, leave the checkbox unchecked.



Active

  • What it does: Determines whether the form can be accessed in the app.
  • How to use it: Check the checkbox to add the form to the app. Otherwise, leave the checkbox unchecked.



Master Page Details Section:

Content Placeholder ID

  • What it does: Master page placeholder property. Options depend on configured placeholders.
  • How to use it: Enter or select the desired option.



Entity Details Section:

Entity

  • What it does: Identifies the entity the form is based on. Options depend on the available entities.
  • How to use it: Click the section's Edit icon. Enter or select the desired entity. Click the Save icon, then save the form.



Method Type

  • What it does: Identifies whether the form is based on a server method instead of an entity. This is a legacy option.
  • How to use it: Click the section's Edit icon. Check the Srv Method checkbox to make the form use a server method, then fill out the rest of the related fields. Click the Save icon, then save the form.



Remote Object

  • What it does: Identifies the server object the form is based on. This field only displays if the Srv Method checkbox is checked.
  • How to use it: Enter or select the desired option.



Load Method

  • What it does: Identifies the method the app uses to load the form objects. This field only displays if the Srv Method checkbox is checked.
  • How to use it: Enter or select the desired option.



Grid Collection

  • What it does: Identifies the collection the remote object's load method loads. This field only displays if the Srv Method checkbox is checked.
  • How to use it: Enter the grid ID.



Main/Sub Query Details Section:

Main Query

  • What it does: Query the app executes when the user performs a search. 
  • How to use it: Click the section's Edit icon. Enter the query in the rightmost field by calling the entity ID, then the query ID. Click the Save icon, then save the form. If left blank, the form searches with the default query (returns all columns from the entity table).



Sub Query

  • What it does: Adds an exists clause to the main query's where condition.
  • How to use it: Click the section's Edit icon. Use the section's icons to add or remove sub queries. Use the row fields to enter/update sub query details. Click the Save icon, then save the form.



Shortcut Keys Section:

Shortcut Keys

  • What it does: Configures shortcuts for actions the user can perform by pressing Alt/Ctrl, plus a keyboard button.
  • How to use it: Click the section's Edit icon. Use the section's icons to add or remove shortcuts. Use the row fields to enter/update shortcut details (form button to execute, key to press to indicate a shortcut, and key to press to execute the shortcut). Click the Save icon, then save the form.


This post is part of the Lookup Form topic. Click here to open the Lookup Form Overview.


#Forms

0 comments
38 views