Share via

HeaderFooterColor Property [Visio 2003 SDK Documentation]

  • Article

Specifies the color of the header and footer text.

colorRet = object**.HeaderFooterColor**

object**.HeaderFooterColor** = colorVal

colorRet     OLE_COLOR. The color of the header and footer text.

object     Required. An expression that returns a Document object.

colorVal     Required OLE_COLOR. The new color for the header and footer text.

Version added

2002

Remarks

Valid values for an OLE_COLOR property within Microsoft Office Visio 2003 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 Microsoft Developer Network.

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.

You can also set this value in the Color box in the Choose Font dialog box (on the View menu, click Header and Footer, and then click Choose Font).

Example

The following macro shows how to assign the color blue to text in the header and footer.

Sub HeaderFooterColor_Example()
 
    'Set color of the header of this 
    'document to blue. 
    ThisDocument.HeaderFooterColor = &H00FF0000 

End Sub

Applies to | Document object

See Also | FooterCenter property | FooterLeft property | FooterMargin property | FooterRight property | HeaderCenter property | HeaderFooterFont property | HeaderLeft property | HeaderMargin property | HeaderRight property