Document.HeaderLeft Property

  • Article
Visio Automation Reference

Gets or sets the text string that appears in the left portion of a document's header. Read/write.

Version Information
 Version Added:  Visio 2002

Syntax

expression.HeaderLeft

expression   A variable that represents a Document object.

Return Value
String

Remarks

You can also set this value in the Left box under Header in the Header and Footer dialog box (View menu).

Both the string that HeaderLeft returns and the string to which you set it 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 HeaderLeft property, see the FooterLeft property

Example

The following macro shows how to place a string containing the current date into the left portion of a document's header. After you run this macro, if the date is May 3, 2007, the left portion of the header contains "The date is Thursday, May 3, 2007".

Visual Basic for Applications 
  
Sub HeaderLeft_Example()
 
    Dim strHeader as String

'Build header string.
strHeader = "The date is " & "&D" 

'Set header of the current document.
ThisDocument.HeaderLeft = strHeader 



End Sub

See Also