WD98: VBA Code to Select or Clear a Check Box in a Dialog Box

ID: q183865

The information in this article applies to:

SUMMARY

In Word you can select (check) or clear a check box option 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, including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose. This article assumes that you are familiar with the programming language being demonstrated and the tools used to create and debug procedures. Microsoft support professionals 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 needs. If you have limited programming experience, you may want to contact the Microsoft fee-based consulting line at (800) 936-5200. For more information about the support options available from Microsoft, please see the following page on the World Wide Web:

http://www.microsoft.com/support/supportnet/refguide/

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 additional information, please see the following article(s) in the Microsoft Knowledge Base:
Q181058 OFF98: How to Run Sample Code from Knowledge Base Articles

For additional information about getting help with Visual Basic for Applications, please see the following article in the Microsoft Knowledge Base:
Q163435 VBA: Programming Resources for Visual Basic for Applications

Additional query words: wordcon vb vba vbe yes no checkbox toggled toggling toggles 


Keywords          : kbdta kbdtacode OffVBA kbmacroexample macword98 
Version           : MACINTOSH:98
Platform          : MACINTOSH 
Issue type        : kbhowto

Last Reviewed: April 8, 1999