HeaderCenter property

Microsoft Visio Developer Reference

HeaderCenter property

   Example   

Contains the text string that appears in the center portion of a document's header.

Version added

2002

Syntax

strRet = object.HeaderCenter
object.HeaderCenter = stringExpression

strRet

String. The text in the center portion of the header.

object

Required. An expression that returns a Document object.

stringExpression

Required String. New text for the center portion of the header.

Remarks

You can also set this value in the Center box under Header in the Header and Footer dialog box (on the View menu, click Header and Footer).

Both strRet and strExpression can contain escape codes that represent data. These escape codes can be concatenated with other text. For a list of valid escape codes you can use with the HeaderCenter property, see the FooterLeft property.

Example

The following macro is used to place the string containing "Document Title" into the center portion of the document's header.

Sub SetHeaderCenter()
    'Set header of current document
    ThisDocument.HeaderCenter = "Document Title"
End Sub

After running this macro, "Document Title" is displayed in the center of the document header.