Check Box Group

The Check Box Group control is a container for a set of controls that are enabled or disabled as a group, by a single check box. The following types of controls can be contained in a Check Box Group: field chooser, dataset selector, check box, combo box, list box, text control, number control, date control, secured text, static text, color picker, table control, radio group, and file browser. The Check Box Group 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 for the group. For multi-line titles or long titles, click the ellipsis (...) button and enter your title in the Title Property dialog.

Checkbox Title. An optional label that is displayed with the controlling check box. Supports \n to specify line breaks.

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

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.

Default Value. The default state of the controlling check box--checked or unchecked.

Checked/Unchecked Syntax. Specifies the command syntax that is generated when the control is checked and when it is unchecked. To include the command syntax in the syntax template, use the value of the Identifier property. The generated syntax, whether from the Checked Syntax or Unchecked Syntax property, will be inserted at the specified position(s) of the identifier. For example, if the identifier is checkboxgroup1, then at run time, instances of %%checkboxgroup1%% in the syntax template will be replaced by the value of the Checked Syntax property when the box is checked and the Unchecked Syntax property when the box is unchecked.

  • 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.
  • You can include identifiers for any controls contained in the check box group. At run time the identifiers are replaced with the syntax generated by the controls.
  • The value %%ThisValue%% can be used in either the Checked Syntax or Unchecked Syntax property. It generates a blank-separated list of the syntax generated by each control in the check box group, in the order in which they appear in the group (top to bottom).
  • By default, the Checked Syntax property has a value of %%ThisValue%% and the Unchecked Syntax property is blank.

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.