Data Lookup
- Last UpdatedOct 17, 2024
- 8 minute read
Use Data Lookup control to search for data from a data source in your form.
Properties
The properties for the control are grouped under the following tabs:
Basic
|
Property |
Description |
|---|---|
|
Name |
Name that identifies the control. This value is also used for the label of the control. |
|
XML Node |
XML node mapped to the control. Use this value to map a list to a form and a form to a workflow.
Note: |
|
Description |
Description for the control. |
|
Tooltip |
Message that appears when the pointer hovers over the control. |
|
Lookup Source |
Name of the item in the Lookup List. To add a name of the item in the Lookup List for the control
|
Appearance
|
Property |
Description |
|---|---|
|
Enable |
Enable or disable the control.
|
|
Visible |
Show or hide the control.
|
|
Read-Only |
Allow or deny a user to enter a value for the control.
|
|
Label Position |
Position of the label for the control.
Note: |
|
Label-Control Area |
Area occupied by the label and the control in percentage.
Note: |
|
Watermark |
Hint text that appears when no value is entered for the control. |
|
Width |
Width in pixels for the control. The default value is 0. Note: If the value is 0, then the width of the control is set as per the default values. |
|
Height |
Height in pixels for the control. The default value is 0. Note: If the value is 0, then the height of the control is set as per the default values. |
|
Retain Space |
Reserve or remove space when the control is hidden.
|
|
Show as Drop-Down |
Enable or disable the control to show as Drop-Down.
Note: If you select Yes, then a user will not be able to type in the control at run-time. |
|
Drop-Down Height |
Drop-down height in pixels for the control. The default value is 300. Note: |
|
Adapt UI |
Change the user interface of the control based on the display width.
Note: The responsiveness of the container depends on the value set for the Desktop View Only property at the Form level. |
Validation
|
Property |
Description |
|---|---|
|
Mandatory |
Enforce or bypass entering a value for the control.
Note:If you configure a Data Lookup control as mandatory, then when you select an item from the drop-down, the mandatory message appears. The message disappears after you have selected an item. |
|
Autocomplete Length |
Number of characters to start autocomplete. The default value is 3. Note: If the value is 0, then the autocomplete length for the control is set as per the default values. |
|
Show Confirmation Message |
Show or hide the confirmation message for clearing the value of the control in devices.
|
|
Confirmation Message Text |
Confirmation message for clearing the value of the control in devices. The default value is Are you sure you want to clear the value? Note: This property is applicable only when the Show Confirmation Message property is set to Yes. |
Advanced
|
Property |
Description |
|---|---|
|
On Data Change |
Run a script when value of the control changes. For more information, see scripting guidelines for On Data Change property. |
|
ID |
Reference identification code for the control. This value is automatically generated and cannot be changed. |
|
Default Number of Records |
Number of records added at run-time for the control. The default value is 50. Note: If the value is 0, then the default number of records for the control is set as per the default values. |
|
Retain Selected Value |
Keep or lose the selected value for the control when the current parameter values from the source get changed.
|
|
Resolve Value in Edit Mode |
When the Form is in the edit mode like opening a Form via WorkItem in Inbox, then update or keep the Lookup display value and the extended information (if the property Extended Information is Yes) based on the selection for the control.
|
|
Persist Display Value |
Keep or lose the display value for the control on submission of the form.
|
|
Extended Information |
Allow or deny a user to access the extended information (that is columns other than the display and value columns of the result set) based on the selection for the control.
|
|
Include in Summary |
Allow or deny a user to view the value in the Summary of a Base Form.
Note: |
Scripts
For information about using scripts, see scripting guidelines for Data Lookup control.
Note:
- The format and culture for date and time value displayed in the control is as per
the current server and not as stored in the database.
- The Autocomplete feature uses the Contains filter to complete user input and is applicable to the Display column as defined in the Lookup Source.
- If the data type of the Autocomplete search column is numeric, date, time, etc.,
it is first converted to a string for comparison before applying the filter.
- When Persist Display Value is set to No, date and date time values are not supported as value fields of the lookup.
- The default data lookup time out is 50 seconds. You can change this value in the web.config file.
<appSettings>
<add key="lookupTimeout" value="50" />
</appSettings>
- When Data Lookup is the first control on a form and the form is viewed on a mobile device, then the
lookup with populated data (ready for entry or selection) is shown instead of the
complete form with other controls.
- Ensure that you map a Number control to an Integer or Numeric type of Data Grid parameter.
Keyboard-based Navigation
You can use the keyboard to perform the following actions:
-
To open the drop-down list,
-
use the Alt + Down Arrow keys (in case, Yes option is selected for the Show as Drop-Down property)
-
type the search string (in case, No option is selected for the Show as Drop-Down property)
-
-
To navigate and highlight the listed option, use the Up and Down Arrow keys.
-
To load more options in the list, use the Alt + Page Down keys.
-
To select highlighted option in the list, use the Enter key.
-
To close the list, use the Esc key.