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

Deleting an Old Document Version

Word allows you to maintain different versions of the same document all within a single document file. Here's how to ...

Discover More

Correctly Saving Delimited Files

Delimited files are often created through Excel so that your data can be exported to other programs. If the delimited ...

Discover More

Moving Building Block Templates

Not all templates are created equal. Word uses two special templates for storing building blocks. If you want to move ...

Discover More

Discover the Power of Microsoft Office This beginner-friendly guide reveals the expert tips and strategies you need to skyrocket your productivity and use Office 365 like a pro. Mastering software like Word, Excel, and PowerPoint is essential to be more efficient and advance your career. Simple lessons guide you through every step, providing the knowledge you need to get started. Check out Microsoft Office 365 For Beginners today!

More WordTips (menu)

Creating a New Document in VBA

When working with documents in a macro, it makes sense that you may need to create a document from time to time. Here's ...

Discover More

Controlling the Italic Text Attribute

If you are formatting your document by using a macro, you may need to make some of your text italics. You do that by ...

Discover More

Determining if Caps Lock is On

If your macro needs to determine the status of the Caps Lock key, you need the code in this tip. Just use the Information ...

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 two more than 6?

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.