WD98: VBA Routines to Determine If Line or Document Is Empty

ID: Q181401

The information in this article applies to:

SUMMARY

When you write a Microsoft Visual Basic for Applications procedure, you may need to know whether or not the insertion point is positioned within an empty document or a blank document line. The sample procedures in this article determine whether the current line or document is empty and then display a message regarding the current status.

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/
The following Visual Basic for Applications Sub procedure uses the predefined bookmark, "\Line," in combination with the Empty function to determine whether the current line is empty. Using this method will detect text as well as inline objects (such as an inline graphic) or floating objects anchored to the current line (such as a text box or drawing object). 

   Sub IsLineEmpty()

      If ActiveDocument.Bookmarks("\Line").Empty Then
         MsgBox "The current line is empty."
      Else
         MsgBox "The current line is not empty."
      End If

   End Sub
For more information about predefined bookmarks, click the Office Assistant while in the Visual Basic Editor, type "Predefined Bookmarks," click Search, and then click to view "Predefined Bookmarks."

NOTE: If the Assistant is hidden, click the Office Assistant button on the Standard toolbar. If Microsoft Help is not installed on your computer, please see the following article in the Microsoft Knowledge Base: 

   ARTICLE-ID: Q179216
   TITLE     : OFF98: How to Use the Microsoft Office Installer Program
The following Visual Basic for Applications Sub and Function procedures use the StoryRanges property to loop through the StoryRanges collection of the active document. Using this method will detect text as well as inline objects (such as an inline graphic) or floating objects anchored to the current line (such as a text box or drawing object). 

   Sub YourMacro()

      ' Call the IsDocEmpty function.
      If IsDocEmpty() Then
         MsgBox "The document is empty."
      Else
         MsgBox "The document contains text, objects or empty lines."
      End If

   End Sub

   Function IsDocEmpty() As Boolean

      ' Initialize function to True
      IsDocEmpty = True
      For Each astory In ActiveDocument.StoryRanges

         ' Check for text. If the length of the
         ' current story is greater than one, then
         ' there is either text or more than one
         ' empty line.
         If Len(astory.Text) > 1 Then
            IsDocEmpty = False
         End If

         ' Check for Objects.
         ' Note: If there are no objects within
         ' the current story range, an error occurs.
         On Error Resume Next

         If astory.ShapeRange.Count > 0 Then
            If Err = 0 Then
               IsDocEmpty = False
            Else
               On Error GoTo 0
            End If
         End If

         ' If something was found, then
         ' return to the calling routine with
         ' a value of False.
         If IsDocEmpty = False Then Exit Function

      Next

   End Function
For more information about the StoryRanges property, click the Office Assistant while in the Visual Basic Editor, type "StoryRanges Property," click Search, and then click to view "StoryRanges Property."

NOTE: If the Assistant is hidden, click the Office Assistant button on the Standard toolbar. If Microsoft Help is not installed on your computer, please see the following article in the Microsoft Knowledge Base: 

   ARTICLE-ID: Q179216
   TITLE     : OFF98: How to Use the Microsoft Office Installer Program

REFERENCES

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
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 In-Line routine routines 
Keywords          : kbdta kbdtacode OffVBA kbmacroexample macword98 
Platform          : MACINTOSH
Issue type        : kbhowto

Last Reviewed: April 7, 1999