OfficeIMO

API Reference

Class

WordListStyles

Edit on GitHub
Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Source OfficeIMO.Word/WordListStyles.Api.cs:18
Modifiers static

Provides access to the built-in list styles and helper methods for working with numbering definitions.

Inheritance

  • Object
  • WordListStyles

Methods

public static Numbering CreateDefaultNumberingDefinitions(WordprocessingDocument document, out Int32 bulletNumberId, out Int32 orderedNumberId) #
OfficeIMO.Word/WordListStyles.Api.cs:71
Returns: Numbering

Creates numbering definitions for basic bulleted and numbered lists.

Parameters

document DocumentFormat.OpenXml.Packaging.WordprocessingDocument requiredposition: 0
The document to base the numbering definitions on.
bulletNumberId System.Int32@ requiredposition: 1
Returns the numbering identifier for bullets.
orderedNumberId System.Int32@ requiredposition: 2
Returns the numbering identifier for ordered lists.

Returns

A Numbering instance containing the definitions.

CreateNewAbstractNum() #

Creates the new abstract number.

GenerateNsidValue() #

Generates a unique NSID value using a GUID

public static AbstractNum GetStyle(WordListStyle style) #
OfficeIMO.Word/WordListStyles.Api.cs:18
Returns: AbstractNum

Retrieves the abstract numbering definition for the specified built-in list style.

Parameters

style OfficeIMO.Word.WordListStyle requiredposition: 0
The list style to retrieve.

Returns

The corresponding AbstractNum definition.

InitializeAbstractNumberId(DocumentFormat.OpenXml.Packaging.WordprocessingDocument document) #

Initializes the abstract number identifier, starting from the highest value currently in use It makes sure that the next abstract number identifier is unique

Parameters

document DocumentFormat.OpenXml.Packaging.WordprocessingDocument required
The document.
public static WordListStyle MatchStyle(AbstractNum abstractNum) #
OfficeIMO.Word/WordListStyles.Api.cs:42
Returns: WordListStyle

Attempts to match an AbstractNum to one of the built-in list styles.

Parameters

abstractNum DocumentFormat.OpenXml.Wordprocessing.AbstractNum requiredposition: 0
The abstract numbering definition to compare.

Returns

The matching WordListStyle or Custom when no match is found.

Fields

nextAbstractNumberId #

The next abstract number identifier stored to be used when creating new abstract numbers