AlarmIndicatorSetInclude

Sets the status of the "Include Equipment references in count" option for the Alarm indicator.

Syntax

AlarmIndicatorSetInclude(IndicatorInclude)

IndicatorInclude:

True or False. When set to true the count will include equipment references when determining the highest priority alarm for an alarm indicator.

Return Value

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, AlarmIndicatorSetEnabled, AlarmIndicatorSetEquipHierarchy, AlarmIndicatorSetExpr, AlarmIndicatorSetFlagEnabled, AlarmIndicatorSetFlagLocation, AlarmIndicatorSetFrameColor

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;