Using check boxes in Formatted Grids

The cell to place the current state of the check box—checked (1) or unchecked (0). You can specify the cell using one of the following options:

• A full cell reference such as C22 or Report!C22
• A column letter such as C (where the row is the current row)
• A relative column location such as +3 or -3 from the current cell

For more information, see Referencing cells in content tag parameters.

The target cell cannot be the same cell that contains the CheckBox tag. The target cell can be anywhere in the spreadsheet and does not need to be visible within the formatted grid.

NOTES:  

• You must choose either TargetCell, FormState, or SharedVariable as the target of the tag. TargetCell is the default behavior and should be used unless the form is being specially designed for use with form state or shared variables.
• When using the Data Source Assistant / Tag Editor, you select either Cell, Form State, or Shared Variable as the Target and then complete the field as appropriate. Your selection will be automatically rendered as the correct parameter when the tag is written to the cell.

The key name for the value to be stored in the form state. For example, IncludeItem. The name must be unique. It is best to define a name that relates to the specific purpose of this check box.

When a form state key name is defined, the current state of the check box is not stored anywhere in the source file. Instead, it is stored in form state memory for the current file. If you need to reference the value within the form, you can use the GetFormState function to return the value into a cell.

The FormState parameter should only be used if the form is intended to be used as a dialog in the Excel Client or the Windows Client, and you need to be able to pass values from the form to the currently active spreadsheet. For more information, see Passing values between an Axiom form and the active client spreadsheet (form state).

The shared variable name to save the selected value as. For example, IncludeItem.

When a variable name is defined, the current state of the check box is not stored anywhere in the source file. Instead, it is saved to the variable list that is stored in memory for the shared form instance. If you need to reference the value within the form, you can use the GetSharedVariable function to return the value into a cell.

The SharedVariable parameter should only be used if the form is intended to be used in an embedded form context (as either the parent form or a child form), and you need to share this value with other forms in the shared form instance. For more information, see Sharing variables between parent and child forms.

Optional. Specifies how interactive controls submit values back to the source file:

• Enabled: The control uses auto-submit behavior, regardless of whether the grid is set to auto-submit. Changed values are submitted as soon as they are changed.

• Disabled: The control does not use auto-submit behavior, regardless of whether the grid is set to auto-submit. Changed values are not submitted until another interactive control triggers a submit.

• Grid: The control honors the auto-submit behavior as configured for the grid.

If omitted, the default behavior is Grid.

Optional. If defined, the label text displays to the right of the check box. Otherwise, only the check box displays in the cell.

You can define the text within the tag directly, or you can use a bracketed cell reference to read the text from another cell. For more information, see Referencing cells in content tag parameters.

This parameter does not apply and is ignored if the ToggleSwitch parameter is set to True.

Optional. Specifies tooltip text to display when a user hovers the cursor over the cell contents.

Alternatively, you can use a bracketed cell reference to read the tooltip text from the referenced cell. This approach is useful if you want to dynamically determine the text, because then the formula can be in the referenced cell instead needing to construct the tag using a formula. For more information, see Referencing cells in content tag parameters.

Optional. The symbol to use to represent the checked state of the check box. By default this is icon-check. You can use any symbol allowed by the Symbol content tag.

When using the Data Source Assistant / Tag Editor, you must first select the Use Custom Symbol check box in order to expose this option. You can then click the ... button to select a symbol from the Choose Symbol dialog. Alternatively, you can use a bracketed cell reference to read the symbol name from another cell. For more information, see Referencing cells in content tag parameters.

This parameter does not apply and is ignored if the ToggleSwitch parameter is set to True.

Optional. The symbol to use to represent the unchecked state of the check box. By default this is icon-check-empty. You can use any symbol allowed by the Symbol content tag.

When using the Data Source Assistant / Tag Editor, you must first select the Use Custom Symbol check box in order to expose this option. You can then click the ... button to select a symbol from the Choose Symbol dialog. Alternatively, you can use a bracketed cell reference to read the symbol name from another cell. For more information, see Referencing cells in content tag parameters.

This parameter does not apply and is ignored if the ToggleSwitch parameter is set to True.

Optional. Specifies whether the control is "active" (True/False). The default value, False, means that the control is active and that the user can check or uncheck the box as needed. If True, then the control becomes "frozen" and no further edits can be made. The control will display the current value of the target cell. This parameter can be used to control whether a user can edit the cell.

Generally speaking, this parameter would only be used within a formula to dynamically enable / disable the check box.

Optional. Specifies how many columns the cell contents will span in the grid.

If this parameter is omitted or set to 1, then content generated by the tag will only span the current column. If you want the content to span multiple columns, enter a number such as 2 to span 2 columns. The column span extends to the right.

NOTE: The row and column styles used in the grid impact how the column span displays. For example, if the content in the starting column is left-aligned and does not naturally exceed the width of the starting column, then the spanned columns will simply be blank because no content is extending to those columns. However, if the content is long enough to extend out of the starting column, or if the content has external borders (such as a text box), or if the content is center-aligned or right-aligned, then content will display in the spanned columns.

Specifies whether the interactive control displays as a check box or as a toggle switch. By default this is False, which means the control displays as a check box. If True, then the control displays as a toggle switch.

When toggle switch behavior is enabled, the following parameters do not apply and are ignored:

• Text
• Symbol-checked

• Symbol-unchecked

When using the Data Source Assistant / Tag Editor, this option is labeled Use Toggle Switch. When you select the check box to use the toggle switch, the On Text and Off Text options are exposed.

Optional. Defines text to display when the switch is toggled to On. By default, the text On is used if no alternate text is defined.