CheckBox - Basic Object

Description

The checkbox is an interface widget that permits the user to make a binary choice (true or false).  To configure a checkbox you will use a boolean tag and it behaves as an input to the user but also as an output in case the boolean tag’s value is being changed somewhere else.

There is an additional configuration that transforms the ComboBox into a three state ComboBox and accepts an integer tag that alternates between -1, 0, and 1 depending on the state of the ComboBox.  Please review the “Configuring a Tag” section below for more information.

Properties and Functions

Info

  • Name
  • Size
  • Location
  • ZIndex
  • Draggable

Configuration

  • Angle
  • Text
  • Text Font
  • Three States
  • Number of Decimals
  • Tag
  • HotKey
  • Is Enabled
  • Is Visible
  • ToolTip

Functions

  • .FontColor
  • .Text
  • .IsChecked
  • .IsCheckedInt
The above properties and functions can be configured using the Property Window when the object is selected but they can also be changed during runtime using a script.  The script must be on the same screen as the object is located and they can be accessed by the name of the object (i.e. objName.Angle = objName.Angle + 1; )

Inserting a CheckBox

To create a new CheckBox in the Graphics Document:

  1. Click the “CheckBox” option in the Ribbon.
  2. Place the mouse pointer where you want to create the CheckBox.
  3. Click to create the new CheckBox.

 

Configuring a Tag

Two States

A two states checkbox accepts a boolean tag and will toggle between true and false values.

The image below shows an example of both states during runtime

Three States

A three states checkbox accepts an integer tag and will toggle between -1, 0 and 1 values.

The image below shows an example of both states during runtime

Script Events

The Checkbox Object provides several Script Events for the user.

  • Mouse Up
  • Mouse Down
  • Mouse While
  • Mouse Right Up
  • Mouse Right Down
  • Mouse Double Click

Security

It is possible to configure different permissions per profile for this object.  For further information, please check the Security white paper.

Scroll Up