Toggle Button Genie
- Last UpdatedJul 18, 2023
- 1 minute read
Genie Name: toggle_button
Genie Library: sa_controls_common
System Project: SA_Controls
The Toggle Button Genie (named "toggle_button") is used to create a toggle button.
Genie Properties
Complete the following properties for the genie in the Genie Properties dialog box.
-
AN: This is an automatically-generated unique ID for the genie object.
-
Name: Optional. If you need to reference the Genie at runtime using Cicode, specify a unique name.
Genie Parameters
Select the genie, then double-click on it. The genie’s parameters are displayed. Complete the following parameters:
|
Parameter |
Description |
|---|---|
|
Click Command |
The function that is called when the operator clicks on the button. No specific arguments are required. |
|
Active When |
An expression (applied in conjunction with Area and Privilege) that can provide further logic to specify when the button is active. |
|
Disabled When |
An expression (applied in conjunction with Area and Privilege) that can provide further logic to specify when the button is disabled. |
|
Tooltip |
Text that displays when the operator hovers the mouse over the button at runtime. |
|
Area |
Enter the area to which the button belongs. Only users with access to this area can use the button. |
|
Privilege |
Enter the privilege level that a user needs to possess to use this button. |
|
Equipment Context |
Can be used to store an equipment context. This is an optional setting that is only used by navigation buttons. Note: If Equipment Context is specified, then the cluster needs to be specified as well. |