Extensibility > Graphics Builder Automation Interface > Alarm Indicator Functions > AlarmIndicatorSetFlagEnabled

AlarmIndicatorSetFlagEnabled

Sets the Alarm Indicator flag.

Syntax

AlarmIndicatorSetFlagEnabled(FlagEnabled)

FlagEnabled:

When set to True a flag is applied to the alarm indicator. When set to false no flag is applied.

Return Value

True or False

Note: For details on handling return and error values, see Error Handling.

Related Functions

AlarmIndicatorGetBorderIsInside, AlarmIndicatorGetBorderPadding, AlarmIndicatorGetBorderWidth, AlarmIndicatorGetEnabled, AlarmIndicatorGetEquipHierarchy, AlarmIndicatorGetExpr, AlarmIndicatorGetFlagEnabled, AlarmIndicatorGetFlagLocation, AlarmIndicatorGetFrameColour, AlarmIndicatorGetInclude, AlarmIndicatorSetBorderIsInside, AlarmIndicatorSetBorderPadding, AlarmIndicatorSetBorderWidth, AlarmIndicatorSetEnabled, AlarmIndicatorSetEquipHierarchy, AlarmIndicatorSetExpr, AlarmIndicatorSetFlagLocation, AlarmIndicatorSetFrameColor, AlarmIndicatorSetInclude

Example

gb2.AlarmIndicatorSetEnabled = true;
gb2.AlarmIndicatorSetExpr = "C1.Motor1";
gb2.AlarmIndicatorSetEquipHierarchy = 0;
gb2.AlarmIndicatorSetBorderIsInside = false;
gb2.AlarmIndicatorSetBorderWidth = 2;
gb2.AlarmIndicatorSetFrameColour = 0x80AAD5;
gb2.AlarmIndicatorSetBorderPadding = 5;
gb2.AlarmIndicatorSetInclude = true;
gb2.AlarmIndicatorSetFlagEnabled = true;
gb2.AlarmIndicatorSetFlagLocation = 3;

Published June 2018