KB183647 - WD98: Simulating a Macro Pause in Visual Basic for Applications

Article ID: 183647

Article Last Modified on 6/17/2005

Microsoft Word 98 for Macintosh

This article was previously published under Q183647

SUMMARY

In Microsoft Visual Basic for Applications, there is no built-in command to allow pausing macro execution. This article contains a Visual Basic for Applications routine to simulate pausing a macro.

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. You can simulate a pause in Visual Basic for Applications by using the following macro example. When the macro runs, it checks to see if there is a command assigned to a specified keystroke. If there is no command assigned, the macro assigns itself as the command. When, the key combination is used in a Word document, this macro example resumes execution and at the same time disables the key assignment made previously.

NOTE: Replace the key constants in this example with the key combination you want to use.

Sub MacroPauseExample()

   Dim mykey as Variant

      'Set the Normal.dot to hold keyboard changes.
      CustomizationContext = NormalTemplate

      ' Determine Pause State by looking at the
      ' specified key combination command assignment.
      Set mykey = KeyBindings.Key(BuildKeyCode _
         (wdKeyControl, wdKeyAlt, wdKeyA))

      ' If there is no Command assignment(meaning
      ' the macro is not in a paused state.)
      If (mykey Is Nothing) Then

         ' ------------------------------------------------------
         ' <Place your code to run, BEFORE the pause occurs, here.>
         ' ------------------------------------------------------

         ' Pause the macro.
         KeyBindings.Add KeyCode:=BuildKeyCode _
            (wdKeyControl, wdKeyAlt, wdKeyA), _
            KeyCategory:=wdKeyCategoryMacro, _
            Command:="MacroPauseExample"
         Exit Sub

      Else ' The macro has been paused. Clear the pause state.

         ' Sets the Normal.dot to hold keyboard changes.
         CustomizationContext = NormalTemplate

         ' Clear Pause State.(Clear the command associated
         ' with the specified key combination.)
         FindKey(BuildKeyCode(wdKeyControl, wdKeyAlt, wdKeyA)).Disable

      End If

      ' ------------------------------------------------------------
      ' <Place your code to run, AFTER the pause is complete, here.>
      ' ------------------------------------------------------------

   End Sub

For additional information, please see the following article in the Microsoft Knowledge Base:

181058 OFF98: How to Run Sample Code from Knowledge Base Articles

REFERENCES

For more information about getting help with Visual Basic for Applications, please see the following article in the Microsoft Knowledge Base:

163435 VBA: Programming Resources for Visual Basic for Applications

Additional query words: wordcon vb vba vbe

Keywords: kbhowto kbmacroexample KB183647