Adding a "CheckBox" Object to a Screen

Navigation:  How to Work with Screens > Adding Menu/Selection Objects to a Screen >

Adding a "CheckBox" Object to a Screen

Previous pageReturn to chapter overviewNext page

 

Object Purpose

 

This object is used to represent a choice made by the device operator that triggers/enables the next action.

 

Add a checkbox to a screen by dragging a "CheckBox" object from the top section of the "Control" tab OR  the "Style Preview Section" onto the screen.

 

Step-by-step

 

1. Drag the object onto the screen:

 

If dragged from the "Control" tab, the object will assume the default style. (See Set Default.)

 

If dragged from the "Style Preview Section", it will assume that particular style.

 

2. Now, double-click the selected object on the screen OR  the representation in the tree view to open the "Properties" window.

 

 

The "General" tab is open by default.

 

3. In the "Check Box Info" section, add/edit the text that will appear on the device's screen.

Either enter text or click and select a variable with the appropriate value (Global, Program or System variable). See Variable Definition.

 

4. Select the position of the text within the object (Left/Right) in the "Text Position" option.

 

5. Define the "Checked Value" as well as the "Unchecked Value" from the available options in the drop-down list.

 

6. Click to create/select the variable that will store the check/unchecked values. See To Select/Create a Variable.

 

7. Go to the "Layout" tab.

 

 

8. Define the object's style by selecting an option from the drop-down list or by clicking . See Editing and Creating Styles and Editing and Creating the "CheckBox" Style.

 

9. Position the text, within the object, with the alignment buttons.

 

10. Maintain the given values or specify the object's position/size, within a screen, by providing the "X" and "Y" coordinates as well as "Width" and "Height".

 

Detail of Position/Size values

 

 

11. In the "Control Settings" section, attribute a name to the object. This name is displayed in the tree view.

 

12. Consider whether or not to check the following options:

"Enable"

Activates the object's input feature.

"Tab Stop"

Must be checked to enable a "Change Tab Order". This provides the possibility to change the order (between data input objects) in which the information is keyed in by the device operator.

"Visible"

Controls the object's visibility in the device's screen.

"Auto Refresh"

Enables an automatic update of the visible information, every time the value of the variables used is modified.

 

Use the right click in MCL-Designer's input boxes to access certain features regarding the input box's option as well as general actions such as "Copy"; "Paste"; "Search".

Ex: If you right-click the "Text Data" input box (included in a "Display Text" properties window), you are provided with the "Paste", "Search..." and "Variable Select" options.

If you right-click any other input box, it will provide other possibilities.

 

 

13. Go to the "Actions" tab.

 

Keep in mind there is always a default event (ex: "On Change"; "On Timer"; "On Hotkey"; etc.) attached to the object (in this case, an "On Change" event). If you want the event to trigger an action, you must add processes to it (ex: "Go To"; "Check File"; "Set Focus"; etc.).

 

 

14. To edit the event, double-click the event row ("On Change") OR  right-click the event row and select "Edit..." in the resulting menu. Either of these choices opens an "Edit Event" window.

 

 

15. Select from the drop-down (B) or (C) list:

 

A

This event, performed by the device operator, is the "trigger" that enables an action to advance the application. It cannot be modified.

Default event: "On Change" - Is triggered when the operator enters data via the "CheckBox" object.

B

Provides targets for a "Go to" action (see Working with the Branch Processes Group). After the device operator has fulfilled the "On Change" event, the workflow will proceed to the selected destination. If you want to add processes other than a "Go to", select the <Action> option.

C

Provides quick links for a "Go to" action ("Next Screen"; "Exit"; etc.) to be executed when the event is fulfilled.

See Detail of a window below.

 

Detail of a window

 

This window is an alternative to the drop-down list of destinations. Select a destination screen or routine within the same program as this object, in the left table. Specify the target even more by selecting from the table to the right. The available options are a consequence of your choice in the left table.

If you want to add more processes, select the <Action> option.

Finish this operation by clicking .

 

16. If required, add processes to the event. See Adding and Editing Processes.

 

This object has predefined local variables (only available in event context). See CheckBox's Predefined Local Variables.

 

 

 

Before concluding the addition operation, check the following:

 

Remember that the "Enable" option (located in the "Layout" tab) must be checked so that the added actions/processes run.

 

 

If required, use the icons located on the upper right corner of the "properties" window:

 

Click this icon to open a "Localization" window where you can edit the text element within that object or add translations to it. See Localization.

 

Click this icon to attach any relevant notes to this object. Enter your text in the resulting window. This information is displayed in the "Developer report". See Report.

 

 

 

17. Click in the "Actions" tab to apply the choices made.

 

The "CheckBox" object has been successfully added to the screen.

 

 

 

If any subsequent edition of the object's properties is required, double-click the "CheckBox" OR  select " 'CheckBox' Properties" (in its right-click menu) to open the properties window.

 

 

 

CheckBox's Predefined Local Variables

 

This object has predefined local variables (only available in event context).

 

Event

On Change

Variable Name

L_Control_Name

L_Checkbox_State

L_Field_Vale

Variable ID

&0a

&1a

&2a

Description

Stores the object's name (*)

CheckBox checked - "1"

CheckBox unchecked - "0"

CheckBox checked - "Yes"

CheckBox unchecked - "No"

 

* Defined in the object's "properties" window ("Layout" tab).