Selection Adorner Auto Genie
- Last UpdatedJul 18, 2023
- 2 minute read
Genie Name: selection_adorner_auto
Genie Library: sa_misc
System Project: SA_Library
The Selection Adorner Auto Genie (named "selection_adorner_auto") is a Genie that enables you to set the context of the workspace by clicking in an area that surrounds a piece of equipment. The border of the adorner is hidden at runtime until an operator points the mouse at the associated piece of equipment. Clicking within the adorner will set the context for the workspace.
The size of the Adorner Auto Genie will automatically adjust to the size of the associated piece of equipment. For example, it will adjust to include an alarm indicator when it appears.
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 |
|---|---|
|
RefAN |
The AN number of the object you want the adorner to surround. By default, the following function is specified: Adorner_GetAnFromName("..\..\Composite") This will retrieve the AN of an assumed sibling object named "Composite". If required, delete this function and enter the AN for the object you would like to use the adorner with. |
|
Padding |
If you want to add padding to the adorner, enter the required padding size in pixels. |
|
IsParentRefAN |
Specifies if the parent AN is used. TRUE = Parent AN is used. FALSE = Parent AN is not used. |
|
OnClickFunction |
A Cicode function that is executed when an operator clicks on the adorner around a piece of equipment with which the adorner is associated. |
|
OnRightClickFunction |
A Cicode function that is executed when an operator right-clicks on the adorner around a piece of equipment with which the adorner is associated. . |
|
Equipment |
The name of the associated piece of equipment that you want use to set the context of the workspace. |
|
EquipmentSecondary |
The name of the piece of equipment that references any sub-equipment. |