ApplicationSettings.StencilBackgroundColor Property (Visio)

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

Syntax

expression. StencilBackgroundColor

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:

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

  • &;H800000 xx , 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 .

Constant Value Description
vbBlack 0x0 Black
vbRed 0xFF Red
** vbGreen** 0xFF00 Green
vbYellow 0xFFFF Yellow
vbBlue 0xFF0000 Blue
** vbMagenta** 0xFF00FF Magenta
** vbCyan** 0xFFFF00 Cyan
** vbWhite** 0xFFFFFF White

You can set the background color for an individual stencil window by using the ActiveWindow.Windows(n).BackgroundColor 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 color by using the ActiveWindow.BackgroundColor property. If you have opened a stencil window in this manner, setting the BackgroundColor property of this stencil window to a value other than the default (-1) overrides the StencilBackgroundColor setting for that window. To reset the background color of the same active stencil window by setting the StencilBackgroundColor property, you must reset BackgroundColor to its default value, -1. If multiple stencil windows of this type are open, setting BackgroundColor for one window has no effect on the setting for other open windows.

Note You can specify two colors for the stencil background. If users' screen resolution is adequate, one of the colors will grade into the other from the top to the bottom of the screen. To be able to use this feature, users must set their monitors to display 32-bit color. The ability to set stencil background color programmatically for users running in high-contrast mode is restricted.