API Reference

Class

WordListNumbering

Namespace OfficeIMO.Word
Assembly OfficeIMO.Word

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

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

Methods

public Void AddLevel(WordListLevel wordListLevel) #
Returns: Void

Adds the level using custom simplified list number.

Parameters

wordListLevel OfficeIMO.Word.WordListLevel requiredposition: 0
The word list level.
public static WordListNumbering CreateNumberingDefinition(WordDocument document) #
Returns: WordListNumbering

Creates a new numbering definition within the specified document.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
The parent document.

Returns

The created WordListNumbering.

public static WordListNumbering GetNumberingDefinition(WordDocument document, Int32 abstractNumberId) #
Returns: WordListNumbering

Retrieves a numbering definition from the document by its identifier.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
The parent document.
abstractNumberId System.Int32 requiredposition: 1
The abstract numbering identifier.

Returns

The WordListNumbering if found; otherwise, null.

public Void RemoveAllLevels() #
Returns: Void

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

Properties

public List<WordListLevel> Levels { get; } #

Gets all numbering levels defined in the underlying AbstractNum element.

public Int32 AbstractNumberId { get; } #

Gets the abstract numbering identifier.