Extensibility > Graphics Builder Automation Interface > Alarm Indicator Functions

Alarm Indicator Functions

The following functions set and define the look of the Alarm indicator belonging to an object or a genie.

AlarmIndicatorGetBorderIsInside

Retrieves the status for the 'Is Inside Flag' for the alarm indicator.

AlarmIndicatorGetBorderPadding

Retrieves the size of the border padding for the alarm indicator.

AlarmIndicatorGetBorderWidth

Retrieves the width of the Alarm Indicator border.

AlarmIndicatorGetEnabled

Retrieves the state of the Alarm Indicator option for an object or genie.

AlarmIndicatorGetEquipHierarchy

Retrieves the location in the equipment hierarchy that will be used to determine the highest priority alarm for the alarm indicator.

AlarmIndicatorGetExpr

Retrieves the Equipment string or expression belonging to the Alarm Indicator.

AlarmIndicatorGetFlagEnabled

Retrieves the status of the Alarm Indicator flag.

AlarmIndicatorGetFlagLocation

Retrieves the position of the flag for the Alarm Indicator.

AlarmIndicatorGetFrameColour

Retrieves the color of the frame of the Alarm indicator.

AlarmIndicatorGetInclude

Retrieves the status of the Include Equipment reference option for the Alarm indicator.

AlarmIndicatorSetBorderIsInside

Sets the Alarm Indicator 'Is Inside flag'. If set to True the border is located within the extent of the object group or Genie.

AlarmIndicatorSetBorderPadding

Sets the size of the border padding in pixels for the Alarm Indicator.

AlarmIndicatorSetBorderWidth

Sets the width in pixels of the Alarm Indicator border.

AlarmIndicatorSetEnabled

Sets the status of the Alarm Indicator option for an object or genie.

AlarmIndicatorSetEquipHierarchy

Set the location in the equipment hierarchy that will be used to determine the highest priority alarm for the Alarm Indicator.

AlarmIndicatorSetExpr

Set the Equipment string or expression that will be used to determine the highest priority alarm for the Alarm Indicator.

AlarmIndicatorSetFlagEnabled

Sets the Alarm Indicator enabled flag. When set to True a flag is applied to the alarm indicator.

AlarmIndicatorSetFlagLocation

Sets the Alarm Indicator flag location. Flag can be positioned at any of the 7 points around the border.

AlarmIndicatorSetFrameColor

Sets the color of the frame for the Alarm Indicator in RGB hex or decimal values.

AlarmIndicatorSetInclude

Sets the status of the "Include Equipment reference count" option for the Alarm indicator. When set to true the count will include equipment references when determining the highest priority alarm for an alarm indicator.

For details and a VB example on handling return and error values, see Error Handling.

See Also

Published June 2018