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

Understanding Document Variables

by Allen Wyatt
(last updated September 14, 2013)

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.

WordTips is your source for cost-effective Microsoft Word training. (Microsoft Word is the most popular word processing software in the world.) This tip (11561) applies to Microsoft Word 2007, 2010, and 2013. You can find a version of this tip for the older menu interface of Word 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

Changing Directories in a Macro

When a macro works with files, it often has to change between different directories on your disk drive. This is done using ...

Discover More

Strange ATAN Results

You may use Excel's trigonometric functions to do some quick calculations, and suddenly notice that the results in your ...

Discover More

Understanding the If ... End If Structure

One of the most basic of programming structures is the conditional structure: If ... End If. This tip explains how this ...

Discover More

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

More WordTips (ribbon)

Saving Changes when Closing

If you write a macro that makes changes to a document, you may want that macro to save those changes. There are several ways ...

Discover More

Determining the Week of the Year

If you are working with dates in a macro, you may need to determine which week of the year a date falls within. This can be ...

Discover More

Displaying the User Name in the Status Bar or Title Bar

Sometimes it can come in handy to know who the current computer user is, as far as Word is concerned. This tip presents ways ...

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}] in your comment text. You’ll be prompted to upload your image when you submit the comment. Maximum image size is 8Mpixels. 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 5 + 0?

2015-05-06 11:41:57

CB

Good explanation on the creation of variables and their insertion in documents.

Could you help wuith the hint to refresh all the instances of the variable accross the document. Some may be in the main body and some in the header or footer.

Thanks and best wishes.


This Site

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

Newest Tips
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.