ApplicationSettings.PrintPreviewBackgroundColor Property

Visio Automation Reference

Determines the background color of the Microsoft Office Visio print preview window. Read/write.

Version Information
 Version Added:  Visio 2003

Syntax

expression.PrintPreviewBackgroundColor

expression   A variable that represents an ApplicationSettings object.

Return Value
OLE_COLOR

Remarks

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 will display 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

Setting the PrintPreviewBackgroundColor property is equivalent to setting the Print Preview background color option in the Color Settings dialog box. (On the Tools menu, click Options, click Advanced, and then click Color Settings.)

Setting the BackgroundColor property of the active window to a value other than the default (-1) overrides the PrintPreviewBackgroundColor setting for that window. To be able to reset the background color of the print preview window by setting the PrintPreviewBackgroundColor property, you must reset BackgroundColor to its default value, -1. If multiple windows are open, setting BackgroundColor for one window has no effect on the setting for other open windows.

Note
The ability to set the drawing background color programmatically for users running in high-contrast mode is restricted.

See Also

• ApplicationSettings Object
• ApplicationSettings Object Members