Checkbox Object

Various Settings and actions associated with the Checkbox object.

Updated over a week ago

A checkbox object is an input object that can capture a yes/no answer from a user.

Accessing value of checkbox

The checkbox object will hold a value of either

  • True (Yes)

  • False (No)

This value can be altered by using the Update Controls on Screen action.

When an action requires you to 'Assign a value', you can use the value set in the checkbox.


The below image shows an Assign Value to Action Result action. It will assign the value stored in the checkbox object called "Checkbox".

Checkbox Object Properties

When you select the checkbox object, you can configure its settings, styles, and events.


  • Caption: The text displayed beside the checkbox. Also used to identify the checkbox in actions.

  • Hide Caption: If labeling for your own information but don’t want the text to show in the live screen, check this box.

  • Load State: The default state of the control (regular/hidden/disabled).

  • Initially set to Checked: Set the default for the checkbox to checked (true) when the screen loads. Default is normally unchecked (false).

  • Check Alignment: Have the checkbox on the left or the right of the caption.

  • Width: How wide the control is in relation to its container. Really only effects when the caption text will wrap.

    • Auto: object will be the width of the caption text and icon.

    • Fixed: assign the width of the object in pixels.

    • Full: object will take up the full width of its container.


  • Checkbox Background color: Set the background color of the checkbox when it is checked. This does not color the text or the background of the text, nor does it affect the color of the checkbox when it is unchecked.

  • Caption color/size/text alignment/font weight: Choose the color, size, alignment, and weight of the text in your caption.

Actions / Events

  • Change event: Event triggers when a user checks or unchecks the box.

Did this answer your question?