ApplicationSettings.StencilBackgroundColorGradient Property (Visio)

Determines the background gradient color of the Microsoft Visio stencil window for the current session. Read/write.

Version Information

Version Added: Visio 2003

Syntax

expression .StencilBackgroundColorGradient

expression A variable that represents an ApplicationSettings object.

Return Value

OLE_COLOR

Remarks

The StencilBackgroundColorGradient property setting does not persist from one session of Visio to the next.

Valid values for an OLE_COLOR property within Visio can be one of the following:

• &H00bbggrr, where bb is the blue value between 0 and 0xFF (255), gg the green value, and rr the red value.

• &H800000xx, where xx is a valid GetSysColor index.

For details about the GetSysColor function, search for "GetSysColor" in the Microsoft Platform SDK on MSDN.

The OLE_COLOR data type is used for properties that return colors. When a property is declared as OLE_COLOR, the Properties window displays a color-picker dialog box that allows the user to select the color for the property visually, rather than having to remember the numeric equivalent.

In addition, you can use the following Microsoft Visual Basic for Applications (VBA) color constants for OLE_COLOR.

You can set the background gradient color for an individual stencil window by using the ActiveWindow.Windows(n).BackgroundColorGradient property, where n represents the index number of the stencil window in the Windows collection. When a stencil window is opened as a floating window, it can be an active window, and you can set its background gradient color by using the ActiveWindow.BackgroundColorGradient property. If you have opened a stencil window in this manner, setting the BackgroundColor property of the active stencil window to a value other than the default (-1) overrides the StencilBackgroundColorGradient setting for that window. To be able to reset the background gradient color of the same active stencil window by setting the StencilBackgroundColorGradient property, you must reset BackgroundColorGradient to its default value, -1. If multiple stencil windows of this type are open, setting BackgroundColorGradient for one window has no effect on the setting for other open windows.