WD2000: How to Implement a Delay in Visual Basic for Applications


Word does not have a built-in method to delay the execution of a macro, but workarounds can be used to achieve this effect.

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.
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
You can use one of the following methods to delay execution of a macro by using Visual Basic for Applications.

Method 1: Use an Empty For...Next Loop

A disadvantage to this method is that there is no direct way to determine the exact amount of time that the program takes to run the loop. The amount of time depends upon the speed of your computer. The following code runs a loop that does nothing but take up some time.

Sub MyDelayMacro

For iCount = 1 to 1000
Next iCount

End Sub

Method 2: Use an API Call to Suspend Word Execution

Use an API call to suspend the execution of Word for a fixed amount of time.

The Kernel32 contains a function that pauses a program's execution for a specified amount of time, specified in milliseconds. For you to use the function, it must first be declared in the General Declarations section of the module in which it will be used:

   Declare Sub Sleep Lib "kernel32" Alias "Sleep" _
(ByVal dwMilliseconds As Long)
Use the following syntax to call the Sleep function:

Sub Sleep()
Sleep 1000 'Implements a 1 second delay
End Sub

Method 3: Use the OnTime Method

Use the OnTime method to set an amount of time to pause. The OnTime method uses the following syntax:

expression.OnTime(When, Name, Tolerance)
Because the Name argument requires the name of a macro to run, you must create two macros: the first macro to contain the OnTime method call and other commands relevant to your macro, and the second macro to run when the allotted time has passed. The second macro can be a "dummy" macro that does nothing.

This example runs the macro named "MyDelayMacro" 15 seconds from the time the example is run.

Sub MyMainMacro()

' Pause for 15 seconds.
Application.OnTime When:=Now + TimeValue("00:00:15"), _

End Sub

Public Sub MyDelayMacro()

' Place your delayed macro commands here.
MsgBox "This macro runs after 15 seconds."

End Sub
For more information about using the OnTime method, in the Visual Basic Editor, click Microsoft Visual Basic Help on the Help menu, type OnTime method in the Office Assistant or the Answer Wizard, and then click Search to view the topic.


For additional information about getting help with Visual Basic for Applications, click the article number below to view the article in the Microsoft Knowledge Base:

212623 WD2000: Macro Programming Resources
226118 OFF2000: Programming Resources for Visual Basic for Applications

Article ID: 212667 - Last Review: Oct 11, 2006 - Revision: 1