A checkbox control allows end users to enter a TRUE or FALSE value. Each checkbox must be associated with a Boolean Single Named Range (B.SNR) in the workbook (i.e. a range pointing to a single cell that evaluates to TRUE or FALSE).
Selecting a named range from the list may default some of the other checkbox properties based on some metadata captured from the spreadsheet model, such as the default value. Named ranges containing formulas are excluded from the list, as well as named ranges that have already been bound to a different input in your user interface.
The Name property constitutes the label that will appear in the user interface.
The Style property will determine the coloring of the checkbox. The predefined color styles are as follows:
- Primary
- Info
- Warning
- Success
- Danger
Users can customize the actual corresponding styles using Cascading Style Sheets (CSS) in the Stylesheet Designer.
The Is Toggle Style checkbox indicates whether or not the checkbox will appear as a toggle, rather than a standard checkbox.
The Alignment property determines the horizontal orientation of the checkbox control. This value can be set to Left, Center, or Right. The default horizontal alignment is Center.
The Default Value property specifies the value that will be visible in this checkbox when the user interface is first loaded. This property may have a suggestion populated if the target named range for the checkbox includes a default value.
For checkbox controls, the default value is either TRUE or FALSE.
Tooltips are informative message boxes that are displayed when you mouse-over or click on a control. The Tooltip Type property determines the message style, and when the information will be shown.
- Tooltip: The content will appear in a small bubble when the user enters focus on the target input by moving their mouse over the control.
- Popover: The content will appear in a pop-up box when the user clicks on the target input.
If Trigger Calculations is selected, changing the value in this input control will trigger a calculation. Calculations perform a server call with all of the inputs from the user interface and populate the output controls with the values from the updated calculation.
In workbooks with complex calculations, enabling calculations may lead to delays in the user experience.
The best practice when determining whether an input should trigger calculations should take into account the following factors:
- Does this input affect any calculated values? If the field is simply informational, then there is no reason to trigger a calculation.
- Does this input affect my user interface? If the field can change the visibility or enabled-ness of pages or other controls, then it is a good idea to trigger calculations when changes occur to the input.
- Will something else trigger calculations before this input is relevant? If the user won’t see the results of the calculations until reaching a different page, then you can hold off on triggering calculations until a button press or a different control’s value is changed.
Enabled indicates whether the checkbox field is enabled. This can be configured as Always or Never to indicate whether the input is statically enabled or not. Alternatively, if any Boolean Single Named Ranges (SNR) exist (i.e. ranges pointing to a single cell that evaluates to TRUE or FALSE), then the enabled-ness of the input can be configured to reflect the value of that named range using the ‘By Value Of’ setting.
Visible indicates whether the checkbox field is visible. This can be configured as Always or Never to indicate whether the input is statically visible or not. Alternatively, if any Boolean Single Named Ranges (SNR) exist (i.e. ranges pointing to a single cell that evaluates to TRUE or FALSE), then the visibility of the input can be configured to reflect the value of that named range using the ‘By Value Of’ setting.