List Box

The List Box control allows you to display a list of items that support single or multiple selection and generate command syntax specific to the selected item(s). The List Box control has the following properties:

Identifier. The unique identifier for the control. This is the identifier to use when referencing the control in the syntax template.

Title. An optional title that appears with the control. For multi-line titles or long titles, click the ellipsis (...) button and enter your title in the Title Property dialog.

ToolTip. Optional ToolTip text that appears when the user hovers over the control.

List Items. Click the ellipsis (...) button to open the List Item Properties dialog box, which allows you to specify the list items of the control. You can also open the List Item Properties dialog by double-clicking the List Box control on the canvas.

Mnemonic Key. An optional character in the title to use as a keyboard shortcut to the control. The character appears underlined in the title. The shortcut is activated by pressing Alt+[mnemonic key].The Mnemonic Key property is not supported on Mac.

List Box Type. Specifies whether the list box supports single selection only or multiple selection. You can also specify that items are displayed as a list of check boxes.

Separator Type. Specifies the delimiter between the selected list items in the generated syntax. The allowed separators are a blank, a comma, and a plus sign (+). You can also enter an arbitrary single character to be used as the separator.

Minimum Selected. The minimum number of items that must be selected in the control, if any.

Maximum Selected. The maximum number of items that can be selected in the control, if any.

Syntax. Specifies the command syntax that is generated by this control at run time and can be inserted in the syntax template.

  • The value %%ThisValue%% specifies the run time value of the control and is the default. If the list items are manually defined, the run time value is the value of the Syntax property for the selected list item. If the list items are based on a target list control, the run time value is the value of the selected list item. For multiple selection list box controls, the run time value is a list of the selected items, delimited by the specified Separator Type (default is blank separated). See the topic Specifying list items for combo boxes and list boxes for more information.
  • You can specify any valid command syntax. For multi-line syntax or long syntax, click the ellipsis (...) button and enter your syntax in the Syntax Property dialog.
Quote Handling. Specifies handling of quotation marks in the run time value of %%ThisValue%% when the Syntax property contains %%ThisValue%% as part of a quoted string. In this context, a quoted string is a string that is enclosed in single quotation marks or double quotation marks. Quote handling applies only to quotation marks that are the same type as the quotation marks that enclose %%ThisValue%%. The following types of quote handling are available.
Syntax
Quotation marks in the run time value of %%ThisValue%% that match the enclosing quotation marks are doubled. For example, if the Syntax property is '%%ThisValue%%' and the selected list item is List item's value, then the generated syntax is 'List item''s value'.
Python
Quotation marks in the run time value of %%ThisValue%% that match the enclosing quotation marks are escaped with the backslash character (\). For example, if the Syntax property is '%%ThisValue%%' and the selected list item is List item's value, then the generated syntax is 'List item\'s value'. Note that quote handling is not done when %%ThisValue%% is enclosed in triple quotation marks.
R
Quotation marks in the run time value of %%ThisValue%% that match the enclosing quotation marks are escaped with the backslash character (\). For example, if the Syntax property is '%%ThisValue%%' and the selected list item is List item's value, then the generated syntax is 'List item\'s value'.
None
Quotation marks in the run time value of %%ThisValue%% that match the enclosing quotation marks are retained with no modification.

Enabling Rule. Specifies a rule that determines when the current control is enabled. Click the ellipsis (...) button to open the Enabling Rule dialog box and specify the rule. The Enabling Rule property is visible only when other controls that can be used to specify an enabling rule exist on the canvas.