Knowledge Base

WD2000: Returning Object Counts for Parts of a Document

Article ID: 212646

Article Last Modified on 10/11/2006

APPLIES TO

Microsoft Word 2000 Standard Edition

This article was previously published under Q212646

SUMMARY

In Visual Basic for Applications, an object represents an element of an application, such as a document, a paragraph, a sentence, a word, or a field.

A collection is an object that contains several other objects, usually, but not always, of the same type. In Microsoft Word, for example, the Documents Collection object contains all the open document objects.

At times it may be necessary when you write Visual Basic for Applications macros to return the number of objects within a particular collection of objects.

This article discusses methods that can be used to return the count of a collection of objects for part or all of a document, including but not limited to objects located in headers, footers, and different sections of a document.

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.

Method 1: To Return a Count of Objects for an Entire Document

To return a count of objects for an entire document, including those contained in headers, footers, comments, endnotes, footnotes, and text frames, use the StoryRanges Collection object.

A Story object is contained within the Story collection. Members of the Story collection are:

The Main Text or Body of a Document
First Page Header
First Page Footer

Primary Header

Primary Footer
Even Pages Headers
Even Pages Footers
Comments
Endnotes
Footnotes
Text Frames

For example, to count the number of fields in all stories of a document, use the following example:

   Sub CountAllFields()
      Dim iCount As Integer
      Dim aStory As Range
      For Each aStory In ActiveDocument.StoryRanges
         iCount = iCount + aStory.Fields.Count
      Next
      MsgBox iCount
   End Sub

To count the number of shapes (drawing objects) in all stories of a document, use the following example:

   Sub CountAllShapes()
      Dim iCount As Integer
      Dim aStory As Range
      For Each aStory In ActiveDocument.StoryRanges
         iCount = iCount + aStory.Application.ActiveDocument.Shapes.Count
      Next
      MsgBox iCount
   End Sub

To count the number of hyperlinks in all stories of a document, use the following example:

   Sub CountAllHyperLinks()
      Dim iCount As Integer
      Dim aStory As Range
      For Each aStory In ActiveDocument.StoryRanges
         iCount = iCount + _
         aStory.Application.ActiveDocument.Hyperlinks.Count
      Next
      MsgBox iCount
   End Sub

Method 2: To Return a Count of Objects for Part of a Document

To return a count of items for a single member of the StoryRange, specify a member of the story range with a wdStoryType constant.

In this example, the wdMainTextStory constant is used in conjunction with the Paragraphs collection to return the count of paragraphs in the main text or body of a document:

   Sub CountParagraphs()
      With ActiveDocument.StoryRanges(wdMainTextStory)
         MsgBox .Paragraphs.Count
      End With
   End Sub

In this example, the wdMainTextStory constant is used in conjunction with the Sentences collection to return the count of sentences in the main body of a document:

   Sub CountSentencesInMainDocBody()
      With ActiveDocument.StoryRanges(wdMainTextStory)
         MsgBox .Sentences.Count
      End With
   End Sub

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

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

REFERENCES

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

226118 OFF2000: Programming Resources for Visual Basic for Applications

Additional query words: vb vba vbe

Keywords: kbdtacode kbhowto kbprogramming KB212646

Microsoft KB Archive/212646

Contents