WD2000: VBA Code to Select or Clear a Check Box in a Dialog Box (212694)

SUMMARY

In Word you can select or clear a check box using the built- in Word dialog boxes. For example, the Background Repagination option is a check box that can be turned on or off (on the Tools menu, click Options, and then click the General tab.) This functionality can be accomplished using a Visual Basic for Applications routine (macro) that you create.

This article provides a sample Visual Basic for Applications routine that demonstrates how to switch a check box state between on and off.

MORE INFORMATION

Microsoft provides programming examples for illustration only, without warranty either expressed or implied. This includes, but is not limited to, the implied warranties of merchantability or fitness for a particular purpose. This article assumes that you are familiar with the programming language that is being demonstrated and with the tools that are used to create and to debug procedures. Microsoft support engineers can help explain the functionality of a particular procedure, but they will not modify these examples to provide added functionality or construct procedures to meet your specific requirements.

In Visual Basic for Applications, a check box in a dialog box has a value of True (-1) to set a selected state, or a value of False (0) to set a cleared state.

The following Visual Basic example turns the Background Repagination option on or off each time you run the macro. When the Background Repagination check box is selected, its state is True (-1); when the check box is cleared, its state is False (0).

Using the logical Not operator, you can switch between the True and False states each time you run the macro. That is, if the state is True, it switches to Not True (False), and if the state is False, it switches to Not False (True).

Sub TogglePagination()
   ' Switches between checked and unchecked states.
   Options.Pagination = Not Options.Pagination
End Sub

Another method you can use checks the state and, dependent upon the state, sets the opposite state using an If...Then...Else statement. Using this method, you can also perform an action based on the current state. For example:

Sub TogglePagination()
   ' Switches between checked and unchecked states.
   If Options.Pagination = True Then
      ' Perform some action if True.
      Options.Pagination = False
   Else
      ' Perform some other action if False.
      Options.Pagination = True
   End If
End Sub

NOTE: When you use Options.Pagination=True, the option is turned on; when you use Options.Pagination=False, the option is turned off.

For more information about how to use the sample code in this article, click the article number below to view the article in the Microsoft Knowledge Base:

212536 OFF2000: How to Run Sample Code from Knowledge Base Articles

WD2000: VBA Code to Select or Clear a Check Box in a Dialog Box (212694)

SUMMARY

MORE INFORMATION

REFERENCES