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

AlarmIndicatorSetFrameColor

Sets the color of the frame for the Alarm Indicator.

Note: Colors are referenced by using hex codes for red, green and blue (RGB) values. You can view RGB values (in decimal) of a selected color by choosing Tools|Edit Favorite Colors in Graphics Builder. If, for example, the color you want to use has the values R = 128, G = 170, B = 213, you can convert these to their hex equivalents (R = 0x80, G = 0xAA, B = 0xD5).

Syntax

AlarmIndicatorSetFrameColor(FrameColor)

FrameColor:

RGB value and -1 for transparency

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, 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