Class

WordListNumbering

OfficeIMO.Word

Namespace: OfficeIMO.Word
Assembly: OfficeIMO.Word
Source revision: 0eef6a5756b9 with working tree changes
Source: WordListNumbering.cs:78

Provides helper methods to manage numbering definitions for lists within a document. Levels can be added or removed and the numbering updated to match the Open XML specification.

Inheritance

object
WordListNumbering

Usage

Explore 5 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 5

Method WordDocument.CreateNumberingDefinition
Method WordDocument.GetNumberingDefinition
Property WordList.Numbering
Method WordListNumbering.CreateNumberingDefinition
Method WordListNumbering.GetNumberingDefinition

Methods

public WordListLevel AddLevel(WordListLevel wordListLevel) #

WordListNumbering.cs:142

Adds the level using custom simplified list number.

Parameters

wordListLevel OfficeIMO.Word.WordListLevel required: The word list level.

Returns

WordListLevel

public static WordListNumbering CreateNumberingDefinition(WordDocument document) #

WordListNumbering.cs:78

Creates a new numbering definition within the specified document.

Parameters

document OfficeIMO.Word.WordDocument required: The parent document.

Returns

WordListNumbering The created WordListNumbering.

public static WordListNumbering? GetNumberingDefinition(WordDocument document, int abstractNumberId) #

WordListNumbering.cs:102

Retrieves a numbering definition from the document by its identifier.

Parameters

document OfficeIMO.Word.WordDocument required: The parent document.
abstractNumberId int required: The abstract numbering identifier.

Returns

WordListNumbering? The WordListNumbering if found; otherwise, null.

public void RemoveAllLevels() #

WordListNumbering.cs:171

Removes all levels to reset the numbering and start from scratch.

Inherited Methods

Properties

public List<WordListLevel> Levels { get; } #

WordListNumbering.cs:18

Gets all numbering levels defined in the underlying AbstractNum element.

public int AbstractNumberId { get; } #

WordListNumbering.cs:37

Gets the abstract numbering identifier.