How to store and retrieve variables in Word documents

How to Set and Retrieve the Value of a Document Variable

The following sample macro uses the Variables property to store and then retrieve the value of a string variable named "FullName" with the current document.

Sub GetSetDocVars()

   Dim fName As String
   fName = "Jeff Smith"
   ' Set contents of variable "fName" in a document using a document
   ' variable called "FullName".
   ActiveDocument.Variables.Add Name:="FullName", Value:=fName
   ' Retrieve the contents of the document variable.
   MsgBox ActiveDocument.Variables("FullName").Value

End Sub

NOTE: The following error message appears if the Variable name is already set in the document:

You must delete the name or just reset the value argument.

How to Delete a Document Variable

The following sample macro uses the Variables property to first set and retrieve the value of a document variable and then delete the variable from the active document.

Sub GetSetDeleteDocVars()

   Dim fName As String
   fName = "Jeff Smith"
   ' Set contents of variable "fName" in a document using a document
   ' variable called "FullName."
   ActiveDocument.Variables.Add Name:="FullName", Value:=fName
   ' Retrieve the contents of the document variable.
   MsgBox ActiveDocument.Variables("FullName").Value
   ' Delete the variable.
   ActiveDocument.Variables("FullName").Delete

End Sub

How to Retrieve the Value of a Document Variable by Using the DocVariable Field

The following sample macro uses the Variables property to set a document variable. Following the sample macro are steps to use the DocVariable field to retrieve the value into the contents of the same document.

Sub GetSetDocVars()

   Dim fName As String
   fName = "Jeff Smith"
   ' Set contents of variable "fName" in a document using a document
   ' variable called "FullName."
   ActiveDocument.Variables.Add Name:="FullName", Value:=fName

End Sub

To use the DocVariable field, follow these steps:

1. On the Insert menu, click Field.
   
   Note In Microsoft Office Word 2007, click Quick Parts in the Text group on the Insert tab, and then click Field.

2. In the Categories box, select Document Automation.

3. In the Field names list, select DocVariable.

4. In the New Name box, under Field properties, type the name of the document variable.
   
   NOTE: If you see Advanced field properties instead of
   Field properties, click Hide Codes.

5. Click OK.

If you need to preserve a value between sessions of a macro, you can store values by using any of the following methods:

• Use the PrivateProfileString property to store values to a private settings file.
  
  For more information about the PrivateProfileString property, in the Visual Basic Editor, click Microsoft Visual Basic Help on the Help menu, type PrivateProfileString Property in the Office Assistant or the Answer Wizard, and then click Search to view the topic.
  

• Use the Variables property to store values in a document.
  
  For more information about the Variables property, in the Visual Basic Editor, click Microsoft Visual Basic Help on the Help menu, type Variables property in the Office Assistant or the Answer Wizard, and then click Search to view the topic.
  

• Use the Visual Basic for Applications Input/Output statements to write to a text file (for example, a Write statement or Print statement).
  
  For more information about writing data to files, in the Visual Basic Editor, click Microsoft Visual Basic Help on the Help menu, type writing data to files in the Office Assistant or the Answer Wizard, and then click Search to view the topic.
  

• Use the AutoTextEntry object to store values in an AutoText entry.
  For more information about the AutoTextEntry object, in the Visual Basic Editor, click Microsoft Visual Basic Help on the Help menu, type AutoTextEntry object in the Office Assistant or the Answer Wizard, and then click Search to view the topic.