List Builder control

Use this control to add a compound widget that allows the user to construct a list of choices.

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

To place a List Builder on a form, click List Builder and then click the form.

Property	Usage
Name	Specify a unique identifier for the object on the screen. (Optional) This name is used by external applications, such as RAD, to dynamically change the properties of the object.
X	Specify the object’s horizontal position based on the left edge of the object.
Y	Specify the object’s vertical position based on the top edge of the object.
Width	Specify the width of the object in alignment grid units.
Height	Specify the height of the object in alignment grid units.
Visible	Select this option to make the object visible on the form. Clear the check box to hide the object from view on the form.
Visible Condition	Specify an expression to override the Visible property when that expression evaluates to true.
Input	Specify the database field or variable to associate with this control.
Tab Stop	Specify the tab sort order for this field. By default, the TAB key navigates the focus on a form from top to bottom and left to right. Objects that have a non-zero Tab Stop are visited first, in ascending order. For a button, file, radio button or check box, you will almost always use the default of 0.
Accessible Name	Specify a component name for use with accessibility software. (Optional) Note: This function is only supported by the Web client. If no name is present, the Web client defaults to looking for a nearby label to use for the name of the component. For buttons, check boxes, or radio buttons, it uses the component’s text. Accessibility software can query the Web client to get this information and use it to present data to the user in a variety of ways. For example, speech simulation software says the name and the type of component when the component has focus.
Accessible Description	Specify a component description for use with accessibility software. (Optional) Note: This function is only supported by the Web client. If no description is present, the Web client defaults to looking for a nearby label to use for the name of the component. For buttons, check boxes, or radio buttons, the Web client will use the component’s text. Accessibility software can query the Web client to get this information, and use it to present it to the user in a variety of ways. For example, when a component gets focus, speech simulation software will say the name and the type of component, based on the settings in the Accessible Name and Accessible Description fields.
Allow Duplicates	Click the box to allow duplicate items.
Choices Name	Specify a label for the Choices list.
Display List	Specify the values that appear in the drop-down list at run time. There must be a one–to–one correspondence between the values for and for Display List. If the Display List is the only populated property, the display values are what is written to the database.
Display List Condition	Specify an expression to override the Display List property when that expression evaluates to true.
Selection Name	Specify a label for the Selections list.
Sortable	Click the box to allow reordering of the list items.
Value List	In conjunction with the Input property, defines how the Display List values are identified in the database. Value and Display Lists are entered using the Edit List dialog box. You can enter hard coded entries for each list, or you can supply a variable as the first and only entry. The run time values of the variable are used to populate these lists. This property is supported only in association with the toolbar configuration Knowledge Management Extended, which is not intended to be used outside of the out-of-box Knowledge Management module.
Value List Condition	Specify an expression to override the Value List property when that expression evaluates to true.

Property

Usage

Name

Specify a unique identifier for the object on the screen. (Optional)

This name is used by external applications, such as RAD, to dynamically change the properties of the object.

Specify the object’s horizontal position based on the left edge of the object.

Specify the object’s vertical position based on the top edge of the object.

Width

Specify the width of the object in alignment grid units.

Height

Specify the height of the object in alignment grid units.

Visible

Select this option to make the object visible on the form. Clear the check box to hide the object from view on the form.

Visible Condition

Specify an expression to override the Visible property when that expression evaluates to true.

Input

Specify the database field or variable to associate with this control.

Tab Stop

Specify the tab sort order for this field. By default, the TAB key navigates the focus on a form from top to bottom and left to right. Objects that have a non-zero Tab Stop are visited first, in ascending order. For a button, file, radio button or check box, you will almost always use the default of 0.

Accessible Name

Specify a component name for use with accessibility software. (Optional)

Note: This function is only supported by the Web client.

If no name is present, the Web client defaults to looking for a nearby label to use for the name of the component. For buttons, check boxes, or radio buttons, it uses the component’s text. Accessibility software can query the Web client to get this information and use it to present data to the user in a variety of ways. For example, speech simulation software says the name and the type of component when the component has focus.

Accessible Description

Specify a component description for use with accessibility software. (Optional)

Note: This function is only supported by the Web client.

If no description is present, the Web client defaults to looking for a nearby label to use for the name of the component. For buttons, check boxes, or radio buttons, the Web client will use the component’s text. Accessibility software can query the Web client to get this information, and use it to present it to the user in a variety of ways. For example, when a component gets focus, speech simulation software will say the name and the type of component, based on the settings in the Accessible Name and Accessible Description fields.

Allow Duplicates

Click the box to allow duplicate items.

Choices Name

Specify a label for the Choices list.

Display List

Specify the values that appear in the drop-down list at run time. There must be a one–to–one correspondence between the values for and for Display List. If the Display List is the only populated property, the display values are what is written to the database.

Display List Condition

Specify an expression to override the Display List property when that expression evaluates to true.

Selection Name

Specify a label for the Selections list.

Sortable

Click the box to allow reordering of the list items.

Value List

In conjunction with the Input property, defines how the Display List values are identified in the database. Value and Display Lists are entered using the Edit List dialog box. You can enter hard coded entries for each list, or you can supply a variable as the first and only entry. The run time values of the variable are used to populate these lists.

This property is supported only in association with the toolbar configuration Knowledge Management Extended, which is not intended to be used outside of the out-of-box Knowledge Management module.

Value List Condition

Specify an expression to override the Value List property when that expression evaluates to true.

Related concepts