DocumentBase.CountNumberedItems Method
Returns the number of bulleted or numbered items and LISTNUM fields in the document.
Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)
Syntax
'Declaration
Public Function CountNumberedItems ( _
ByRef numberType As Object, _
ByRef level As Object _
) As Integer
public int CountNumberedItems(
ref Object numberType,
ref Object level
)
Parameters
- numberType
Type: System.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
Type: System.Object%
A number that corresponds to the numbering level you want to count. The default is that all levels are counted.
Return Value
Type: System.Int32
The number of bulleted or numbered items and LISTNUM fields in the document.
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.
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 Sub DocumentCountNumberedItems()
Dim numCount As Integer = Me.CountNumberedItems( _
Word.WdNumberType.wdNumberAllNumbers)
MessageBox.Show(("Numbered items in this document: " + _
numCount.ToString()))
End Sub
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());
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.