Faceplate Button Genie
- Last UpdatedJul 18, 2023
- 2 minute read
Genie Name: button_fp_<n>_<n>
Genie Library: sa_faceplate
System Project: SA_Library
The Faceplate Button Genie allows you to add a button to a faceplate.
Note: If you need a button that binds directly to an item, use the Faceplate Command Button Genie.
The button features two indicators.
-
Targeted indicator - indicates that a command has been issued, but has not completed.
-
Normal mode indicator - indicates that the associated piece of equipment is in its normal operational state. For example, if the button represents Auto/Manual, then Auto maybe the normal operational state and is therefore indicated as such.
Two variations of the Genie are included in the SA_Library project:
-
button_fp_112_44
-
button_fp_84_40
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 and double-click on it to view its parameters. The parameters are used as described in the table below:
|
Parameter |
Description |
|---|---|
|
Equipment Context |
An equipment name that is used to define equipment context, or a Super Genie association that defines equipment context. By default, the following is used: ?__EquipmentRef? This specifies that the current workspace context is used. |
|
Label |
The text label that appears on the button. |
|
Tooltip |
Additional text that appears when the mouse hovers over the button. |
|
Click Command |
An expression that is called when the button is clicked on. |
|
Active When |
An expression (applied in conjunction with Area and Privilege) that can provide further logic to specify when the button is active. |
|
Normal When |
An expression that determines when the normal mode indicator displays. |
|
Targeted When |
An expression that determines when the targeted indicator displays. |
|
Disabled When |
An expression (applied in conjunction with Area and Privilege) that can provide further logic to specify when the button is disabled. |
|
Hidden When |
An expression that determines when the button is hidden. |
|
Security: Area |
Enter the area to which the button belongs. Only users with access to this area can use the button. |
|
Security: Privilege |
Enter the privilege level that a user needs to possess to use this button. |