DocumentBase.CountNumberedItems(Object, Object) Method

Reference

Definition

Namespace:: Microsoft.Office.Tools.Word

Assembly:: Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the number of bulleted or numbered items and LISTNUM fields in the document.

public int CountNumberedItems (ref object numberType, ref object level);

member this.CountNumberedItems : obj * obj -> int

Public Function CountNumberedItems (Optional ByRef numberType As Object, Optional ByRef level As Object) As Integer

Parameters

numberType: Object

The type of numbers to be counted. Can be one of the following WdNumberType values: wdNumberParagraph, wdNumberListNum, or wdNumberAllNumbers. The default value is wdNumberAllNumbers.

level: Object

A number that corresponds to the numbering level you want to count. The default is that all levels are counted.

Returns

Int32

The number of bulleted or numbered items and LISTNUM fields in the document.

Examples

The following code example uses the CountNumberedItems method to display the quantity of all numbered items in the document. To use this example, run it from the ThisDocument class in a document-level project.

private void DocumentCountNumberedItems()
{
    object numberType = Word.WdNumberType.wdNumberAllNumbers;

    int numCount = this.CountNumberedItems(ref numberType, ref missing);
    MessageBox.Show("Numbered items in this document: " + 
        numCount.ToString());
}

Private Sub DocumentCountNumberedItems()
    Dim numCount As Integer = Me.CountNumberedItems( _
        Word.WdNumberType.wdNumberAllNumbers)
    MessageBox.Show(("Numbered items in this document: " + _
        numCount.ToString()))
End Sub

Remarks

Bulleted items are counted when either wdNumberParagraph or wdNumberAllNumbers (the default) is specified for NumberType.

There are two types of numbers: preset numbers (wdNumberParagraph), which you can add to paragraphs by selecting a template in the Bullets and Numbering dialog box; and LISTNUM fields (wdNumberListNum), which enable you to add more than one number per paragraph.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Applies to