Configuring Custom Properties
- Last UpdatedJul 13, 2023
- 3 minute read
You can configure custom properties when you create them or at a later point of time.
To configure a custom property
-
Click the canvas of the graphic.
-
On the Special menu, click Custom Properties. The Edit Custom Properties dialog box appears.
-
Select the custom property you want to edit. The configuration for the selected custom property appears at the right of the dialog box.
Note: The header of the configuration area shows the graphic name on the right, for example "Symbol_001," and it shows the custom property name on the left, for example "MyCustomProperty." Its reference in a script would be "Symbol_001.MyCustomProperty."
-
In the Data Type list, click the data type of the custom property. You can select one of the following:
Data Type
Graphic
Boolean

Double

Elapsed Time

Float

Integer

String

Time

-
If you want to:
-
Make the property read-only at design time and prevent further changes to it when the graphic is embedded into another graphic, click the Lock icon.
-
Make the property read-only at run time and prevent its value being changed, click the Lock icon.
-
-
In the Default Value box, type a literal value, reference, or expression or browse for a reference using the Browse icon.
-
If the selected data type is String, Time or Elapsed Time, you can click the T icon or tag icon.
-
Select the T icon to indicate that the default value is a static value.
-
Select the tag icon to indicate that the default value is a reference to a value.
-
-
In the Visibility box, configure how the graphic is visible. Do one of the following:
-
Click Public if you want the custom property to be visible and can be used in a source graphic if the graphic is embedded.
-
Click Private if you want the custom property to be hidden and no reference be made to it outside of the defining graphic.
-
-
In the Description box, type a meaningful description for the custom property.