Microsoft KB Archive/201995

From BetaArchive Wiki
Knowledge Base


WD2000: How to Keep OnEntry Macro from Running at Document Open

Article ID: 201995

Article Last Modified on 10/11/2006



APPLIES TO

  • Microsoft Word 2000 Standard Edition



This article was previously published under Q201995


SUMMARY

When you use form fields in Word and you have assigned an OnEntry macro to the first form field in a document, the OnEntry macro automatically runs when the document first opens.

This article contains a sample Microsoft Visual Basic for Applications macro (Sub procedure) that can be used to work around this issue.

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.
The following sample Visual Basic for Applications macro tests to see whether, upon the execution of the macro, the document's Open event has triggered the OnEntry macro.

   Sub OnEntry()

      Dim sOpenStatus As String
      ' An error occurs the first time this macro is
      ' run because the document variable does not yet exist,
      ' so we just resume to the next line (the If...Then...Else
      ' statement).
      On Error Resume Next

      ' Get the value of the document variable DocOpen,
      ' and put the value into the string variable sOpenStatus.
      sOpenStatus = ActiveDocument.Variables("DocOpen")

      If sOpenStatus = "" Then

         ' On the first run of this macro, the value of
         ' sOpenStatus will be Null because it does not
         ' yet exist, so we create the document variable and
         ' set the value to "Already Open."
         ActiveDocument.Variables.Add Name:="DocOpen", _
            Value:="Already Open"

      ElseIf sOpenStatus = "Just Opened" Then

         ' If the value of the document variable equals "Just Opened,"
         ' do not run the other code section of this macro
         ' and make the document variable equal "Already Open."
         ActiveDocument.Variables("DocOpen").Value = "Already Open"

      Else

         ' Other code section runs ONLY if the variable
         ' sOpenStatus equals "Already Open." Place your
         ' code here that you want to run only when the
         ' form field is tabbed to or clicked on.

         '<<< Your OnEntry Code Goes Here >>>

      End If

   End Sub
                



This macro must be used in combination with the OnEntry macro to set the document variable DocOpen to "Just Opened", so the next time the document is opened, the other code section of the OnEntry macro included earlier in this article does not run.

   Sub AutoClose()

      ' This sets the value to "Just Opened", so
      ' the next time the document is opened,
      ' the other code does not run.
      ActiveDocument.Variables("DocOpen").Value = "Just Opened"

   End Sub
                

REFERENCES

For additional information about running sample code, please see the following article in the Microsoft Knowledge Base:

ARTICLE-ID: 212536
TITLE : WD2000: How to Run Sample Code from Knowledge Base Articles



Additional query words: on-entry

Keywords: kbdtacode kbhowto kbmacroexample kbprogramming KB201995