Please Note: This article is written for users of the following Microsoft Word versions: 2007, 2010, 2013, 2016, 2019, and Word in Office 365. 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 June 25, 2018)

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 (11561) applies to Microsoft Word 2007, 2010, 2013, 2016, 2019, and Word in Office 365. 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

Making Word Stop at the End of a Document when Reviewing Changes

The Track Changes tool is a great help when you want to see what edits have been made to a document. When you review ...

Discover More

Specifying a Data Validation Error Message

Data validation is a great tool for limiting what can be input into a cell. Excel allows you to specify what should ...

Discover More

Easily Entering Dispersed Data

Need to enter information into a bunch of cells that aren't anywhere near each other in the worksheet? Here's a handy way ...

Discover More

Create Custom Apps with VBA! Discover how to extend the capabilities of Office 2013 (Word, Excel, PowerPoint, Outlook, and Access) with VBA programming, using it for writing macros, automating Office applications, and creating custom applications. Check out Mastering VBA for Office 2013 today!

More WordTips (ribbon)

Detecting the Beginning of a Sentence in a Macro

Macros can make life easier, as they provide a fast and efficient way of processing text in a document. Such is the case ...

Discover More

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

Resetting Character Formatting in a Macro

Shortcut keys are a great way to apply styles to text in a document. You can easily create a shortcut key assignment for ...

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 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 less than 9?

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.