AlarmIndicatorSetEnabled

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

Syntax

AlarmIndicatorSetEnabled(IndicatorEnabled)

IndicatorEnabled:

True or False. When set to True an alarm indicator will be applied to an object or genie.

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, AlarmIndicatorGetFrameColor, AlarmIndicatorGetInclude, AlarmIndicatorSetBorderIsInside, AlarmIndicatorSetBorderPadding, AlarmIndicatorSetBorderWidth, AlarmIndicatorSetEquipHierarchy, AlarmIndicatorSetExpr, AlarmIndicatorSetFlagEnabled, 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 = false;

gb2.AlarmIndicatorSetFlagLocation = 0;