IPen​.AxisBackgroundColor [Property][Get/Set]

Gets or sets the background color of the axis of this pen.

Defined As

• [VBA] Long BackgroundColor

• [Cicode] INT BackgroundColor

• [C++] OLE_COLOR BackgroundColor

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 then the return value will be GeneralFailure.

Remarks

The background is the area underneath the axis lines and values.

To calculate the integer value necessary for a color apply the following formula (65536 * Blue) + (256 * Green) + (Red). Where Red, Green and Blue are 0-255

Calling Syntax

Assumes you have passed a valid pen object into the function.

[VBA]

Sub Example(pen As Object)
Dim backgroundColor As Long
`Getting Property value
backgroundColor = pen.AxisBackgroundColor
`Setting Property value to Red
pen.AxisBackgroundColor = 255
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
INT backgroundColor;
// Getting current property value
backgroundColor = _ObjectGetProperty(hPen, "AxisBackgroundColor");
// Setting Property to Red
_ObjectSetProperty(hPen, "AxisBackgroundColor", PackedRGB(255, 0, 0));
END