Please Note: This article is written for users of the following Microsoft Word versions: 97, 2000, 2002, and 2003. If you are using a later version (Word 2007 or later), this tip may not work for you. For a version of this tip written specifically for later versions of Word, click here: Understanding Document Variables.

Understanding Document Variables

Written by Allen Wyatt (last updated September 28, 2019)
This tip applies to Word 97, 2000, 2002, and 2003


1

Visual Basic for Applications allows you to create persistent variables that are associated with a document. Document variables are typically used to maintain some sort of information from one invocation of a macro to the next. For instance, you may want your macro to remember the defaults that it uses when prompting the user. These defaults can be stored within document variables.

To create a document variable within a macro, you use the Add method with the Variables collection. All you need to do is provide the name for the variable and the value you want assigned to the variable. For instance, the following macro line will create a variable called MyVar and assign it a value of 27:

ActiveDocument.Variables.Add Name:="MyVar", Value:=27

At a later time, you can access the value associated with the variable by using the variable's name, as follows:

DefaultToUse = ActiveDocument.Variables("MyVar")

Typically, users would never see the contents of a document variable; they are intended primarily for use within macros. You can, however, insert the contents of a document variable directly within a document by using the DOCVARIABLE field, as follows:

{ DOCVARIABLE "MyVar" }

When updated, the field returns the value assigned to the MyVar document variable.

Note:

If you would like to know how to use the macros described on this page (or on any other page on the WordTips sites), I've prepared a special page that includes helpful information. Click here to open that special page in a new browser tab.

WordTips is your source for cost-effective Microsoft Word training. (Microsoft Word is the most popular word processing software in the world.) This tip (813) applies to Microsoft Word 97, 2000, 2002, and 2003. You can find a version of this tip for the ribbon interface of Word (Word 2007 and later) here: Understanding Document Variables.

Author Bio

Allen Wyatt

With more than 50 non-fiction books and numerous magazine articles to his credit, Allen Wyatt is an internationally recognized author. He is president of Sharon Parq Associates, a computer and publishing services company. ...

MORE FROM ALLEN

Odd Arrow Key Behavior

Press the up or down arrow keys, and you expect Excel to change which cell is selected. If this doesn't occur on your ...

Discover More

Printing Close to the Edge

Word allows you to specify all sorts of paper sizes and margins for your documents. If your margins result in trying to ...

Discover More

Identifying Digit-Only Part Numbers Excluding Special Characters

When working with data in Excel, you often need to determine if that data meets criteria that you specify. This tip ...

Discover More

Learning Made Easy! Quickly teach yourself how to format, publish, and share your content using Word 2021 or Microsoft 365. With Step by Step, you set the pace, building and practicing the skills you need, just when you need them! Check out Microsoft Word Step by Step today!

More WordTips (menu)

Converting Numbers to Text

Got some numbers you need spelled out? Here's a handy macro that can convert numbers like "123" to words like "one ...

Discover More

Displaying a Message in the Status Bar

A great place for your macro to display status information is, well, in the status bar. Displaying the information is ...

Discover More

Clearing the Undo Stack in a Macro

When writing a macro, you may need a way to clear the undo stack. This can be done with a single command, as described in ...

Discover More
Subscribe

FREE SERVICE: Get tips like this every week in WordTips, a free productivity newsletter. Enter your address and click "Subscribe."

View most recent newsletter.

Comments

If you would like to add an image to your comment (not an avatar, but an image to help in making the point of your comment), include the characters [{fig}] (all 7 characters, in the sequence shown) in your comment text. You’ll be prompted to upload your image when you submit the comment. Maximum image size is 6Mpixels. Images larger than 600px wide or 1000px tall will be reduced. Up to three images may be included in a comment. All images are subject to review. Commenting privileges may be curtailed if inappropriate images are posted.

What is 4 - 4?

2024-08-31 17:09:29

Mike

What is the data type of document variables? Must numbers be converted to one form or other before saving or using document variables in math, or as a Boolean?


This Site

Got a version of Word that uses the menu interface (Word 97, Word 2000, Word 2002, or Word 2003)? This site is for you! If you use a later version of Word, visit our WordTips site focusing on the ribbon interface.

Videos
Subscribe

FREE SERVICE: Get tips like this every week in WordTips, a free productivity newsletter. Enter your address and click "Subscribe."

(Your e-mail address is not shared with anyone, ever.)

View the most recent newsletter.