IProcessAnalyst​.BackgroundColor [Property][Get/Set]

Gets or sets the background color for the Process Analyst.

Defined As

• [VBA] Long BackgroundColor

• [Cicode] INT BackgroundColor

• [C++] OLECOLOR BackgroundColor

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.

Remarks

The background is the area under the panes. 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.

Limits

• True (-1): Context menu is enabled

• False (0): Context menu is disabled

Calling Syntax

Assumes you have a page called "myPage" and the Process Analyst has been named "AN35".

[VBA]

Sub Example()
Dim backgroundColor As Long
`Getting Property value
backgroundColor = myPage_AN35.BackgroundColor
`Setting Property value to Red
myPage_AN35.BackgroundColor = 255
End Sub

[Cicode]

FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName("AN35");
INT backgroundColor;
// Getting current property value
backgroundColor = _ObjectGetProperty(hProcessAnalyst,"BackgroundColor");
// Setting Property to Red
_ObjectSetProperty(hProcessAnalyst, "BackgroundColor", 255);
END