Check Box
Introduction
A Check Box displays a control in the Viewer that when checked or unchecked sends a stored Message to Check Box's "Get Value" output connector. The message sent corresponds to the Check Box's check state - whether it is checked or not. Any data can be stored as its checked or unchecked value by sending a message to the corresponding input connector. By default, the Check Box outputs a checked value of "true" and an unchecked value of "false". Check Box also acts as a gate and will immediately output a received message only if its arrives at the input connector that matches its current check state.
Viewer Control:
Toggling the Check Box
- Click the Check Box's control at any time in the Viewer to switch its check state and trigger the "Get Value" output connector to output the corresponding checked or unchecked value.
See Also:
Input Menu:
Set Is Checked
Sets whether the Check Box is checked or not.
Accepted Datatypes:
- True/False
- 'True' sets the check state to checked; 'false' sets the check state to unchecked.
Triggered Outputs:
- Output Message:
- Get Value
- Output Message:
- Get Is Checked
Set Checked Value
Sets the value of the stored data that is output by the "Get Value" output connector when the Check Box is checked.
Accepted Datatypes:
- Any
- Any type of data.
Triggered Outputs:
- Output Message:
- Get Value
Set Unchecked Value
Sets the value of the stored data that is output by the "Get Value" output connector when the Check Box is unchecked.
Accepted Datatypes:
- Any
- Any type of data.
Triggered Outputs:
- Output Message:
- Get Value
Output Menu:
Get Is Checked
Gets the current check state of the Check Box.
Output Datatype:
- True/false
- 'True' if the Check Box is checked; 'false' if it is unchecked.
Triggered By:
- Input Message:
- Set Is Checked
- Action:
- Clicking on the Check Box's control in the Viewer.
Get Value
Gets the value of the Check Box's stored data according to its current check state. If no data has been stored for the checked or unchecked state via the "Set Checked Value" or "Set Unchecked Value" input connectors, this connector will output a default value of "true" when checked and "false" when unchecked.
Output Datatype:
- Any
- The data type of the corresponding checked or unchecked value stored in the Check Box.
Triggered By:
- Input Message:
- Set Checked Value
- Input Message:
- Set Unchecked Value
- Input Message:
- Set Is Checked
- Action:
- Clicking on the Check Box's control in the Viewer.