Edit

Share via


Word.DocumentCountNumberedItemsOptions interface

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Provides configuration options for the Document.countNumberedItems method.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

level

If provided, specifies the level of numbering to count. If omitted, all levels are counted.

numberType

If provided, specifies the type of numbered items to count. The default value is allNumbers.

Property Details

level

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the level of numbering to count. If omitted, all levels are counted.

level?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

numberType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the type of numbered items to count. The default value is allNumbers.

numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers";

Property Value

Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]