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

Gets or Sets the color that will be used to draw the pen line.

Defined As

• [VBA] Long LineColor

• [Cicode] INT LineColor

• [C++] OLE_COLOR LineColor

Execution Result

If the property get/set succeeds the return value will be Success. If the return variable is bad then 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.

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 lineColor As Long
`Getting Property value
lineColor = DigitalPen.LineColor
`Setting Property to red
digitalPen.LineColor = 255
End Sub

[Cicode]

FUNCTION Example(OBJECT hDigitalPen)
// Getting property value
INT nLineColor = _ObjectGetProperty(hDigitalPen, "LineColor");
// Setting property to red
_ObjectSetProperty(hDigitalPen, "LineColor", 255);
END