OfficeIMO

API Reference

Class

DocumentTraversal

Edit on GitHub
Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Source OfficeIMO.Word/Converters/DocumentTraversal.cs:46
Modifiers static

Provides helper methods for traversing documents and resolving list markers.

Inheritance

  • Object
  • DocumentTraversal

Methods

public static Dictionary<WordParagraph, ValueTuple<Int32, Int32>> BuildListIndices(WordDocument document) #
OfficeIMO.Word/Converters/DocumentTraversal.cs:150
Returns: Dictionary<WordParagraph, ValueTuple<Int32, Int32>>

Builds a lookup of list numeric indices for all paragraphs in the document. The returned index is the 1-based number of the item at its nesting level, accounting for list continuation across unrelated content.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
public static Dictionary<WordParagraph, ValueTuple<Int32, String>> BuildListMarkers(WordDocument document) #
OfficeIMO.Word/Converters/DocumentTraversal.cs:113
Returns: Dictionary<WordParagraph, ValueTuple<Int32, String>>

Builds a lookup of list markers for all paragraphs in the document.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
public static IEnumerable<WordSection> EnumerateSections(WordDocument document) #
OfficeIMO.Word/Converters/DocumentTraversal.cs:46
Returns: IEnumerable<WordSection>

Enumerates all sections within the document.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
public static Nullable<ListInfo> GetListInfo(WordParagraph paragraph) #
OfficeIMO.Word/Converters/DocumentTraversal.cs:55
Returns: Nullable<ListInfo>

Resolves list information for the given paragraph.

Parameters

paragraph OfficeIMO.Word.WordParagraph requiredposition: 0
Paragraph to inspect.

Returns

List info for the paragraph or null when paragraph isn't a list item.