WD98: Cancel Action Doesn't Function in Converted Macro

ID: Q182015

The information in this article applies to:

Microsoft Word 98 Macintosh Edition

SYMPTOMS

When you click Cancel in the Bullets And Numbering dialog box that appears when you run a WordBasic macro that has been converted to a Visual Basic for Applications macro that uses the FormatHeadingNumbering commands to display the Bullets and Numbering dialog box, the macro skips the check for the action of pressing Cancel.

CAUSE

In Microsoft WordBasic you can check for a user clicking Cancel in a dialog box by testing for a return value of zero. When the WordBasic object is used in conjunction with a converted WordBasic macro, the value returned is -1 instead of 0 when you click Cancel.

For example, the following code sample was converted from WordBasic to Visual Basic for Applications:

   Sub Main()
      Dim dlg As Object
      Set dlg = WordBasic.DialogRecord.FormatHeadingNumbering(False)
      WordBasic.CurValues.FormatHeadingNumbering dlg
      x = WordBasic.Dialog.FormatHeadingNumbering(dlg)
      ' In WordBasic, if the Cancel button was pressed, x will equal zero.
      If x = 0 Then
         ' Because Visual Basic for Applications WordBasic object returns
         '  -1 for Cancel, any commands in this If...Then...Else statement
         ' will be skipped when Cancel is clicked.
         MsgBox "Cancel was pressed."
      End If
   End Sub

WORKAROUND

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/

To work around this problem check for the value of -1 instead of 0 as in the following example:

   Sub Main()
      Dim dlg As Object
      Set dlg = WordBasic.DialogRecord.FormatHeadingNumbering(False)
      WordBasic.CurValues.FormatHeadingNumbering dlg
      x = WordBasic.Dialog.FormatHeadingNumbering(dlg)
      ' If the Cancel button was pressed, x will equal -1.
      If x = -1 Then
         ' Perform actions based on the Cancel button being clicked.
      End If
   End Sub

NOTE: Using Visual Basic for Applications commands without the WordBasic object returns 0 for a Cancel button. For example, the following routine performs the same functionality as the converted WordBasic macro examples described earlier in this article:

   Sub ShowDlg()
      ' Display the Bullets and Numbering Dialog.
      With Dialogs(wdDialogFormatBulletsAndNumbering)
         .DefaultTab = wdDialogFormatBulletsAndNumberingTabOutlineNumbered
         x = .Show
      End With
      ' If x=zero then the Cancel button was clicked.
      If x = 0 Then
         MsgBox "Cancel was pressed."
      End If
   End Sub

STATUS

Microsoft has confirmed this to be a problem in the Microsoft products listed at the beginning of this article.

MORE INFORMATION

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

   ARTICLE-ID: Q173707
   TITLE     : OFF97: 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:

   ARTICLE-ID: Q163435
   TITLE     : VBA: Programming Resources for Visual Basic for
               Applications

Additional query words: wordcon vb vba vbe

Keywords          : kbdta OffVBA kbmacroexample macword98 
Version           : MACINTOSH:98
Platform          : MACINTOSH
Issue type        : kbbug
Solution Type     : kbnofix

Last Reviewed: April 7, 1999