Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Plant SCADA

IDigitalPen​.FillColor [Property][Get/Set]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Gets or Sets the color that will be used to fill the area under the line when the value is 1.

Defined As

  • [VBA] Long FillColor

  • [Cicode] INT FillColor

  • [C++] OLE_COLOR FillColor

Execution Result

If the property get/set succeeds, the return value will be Success. If the return variable is bad, the return value will be InvalidArgument. If the pen is deleted, the return value will be GeneralFailure.

Remarks

The color value can be calculated using the following formula:

color = (65536 * blue) + (256 * green) + (red)

where red, green, and blue are 0-255. The area under the line is filled with this color if the value of the Fill property is True (-1).

Calling Syntax

This example assumes there is a valid DigitalPen object to be passed into the example methods.

[VBA]

Sub Example(digitalPen As Object)

Dim fillColor As Long

`Getting Property value

fillColor = digitalPen.FillColor

`Setting Property to red

digitalPen.FillColor = 255

End Sub

[Cicode]

FUNCTION Example(OBJECT hDigitalPen)

// Getting property value

INT nFillColor = _ObjectGetProperty(hDigitalPen, "FillColor");

// Setting property to red

_ObjectSetProperty(hDigitalPen, "FillColor", 255);

END

See Also

IDigitalPen.Fill [Property][Get/Set]

In This Topic
TitleResults for “How to create a CRG?”Also Available in