Table of Contents

Class IndexEditingExtensions

Namespace
DocWright.Dom.Editing
Assembly
DocWright.Dom.dll

Word's References > Mark Entry and Insert Index as undoable edits (tools/Probe-WordIndex.ps1, WQ-0113): an XE field after the marked text, an INDEX field in a continuous section of its own with its columns, its entries in the Index 1-9 styles, rebuilt by an update with the page numbers PageNumberAt gives.

public static class IndexEditingExtensions
Inheritance
IndexEditingExtensions
Inherited Members

Fields

MaxColumns

The most columns an index has (Word's Index dialog).

MaxEntryLength

The longest entry, subentry or cross-reference text.

MaxIndexEntries

The most XE fields an index lists; the rest are left out.

NoEntriesText

Word's result when the document marks no entries.

Methods

InsertIndex(WordDocument, DocumentPosition, IndexOptions?, FieldUpdateOptions?)

Inserts an index at a position, as one undoable edit (Word's Insert Index): the INDEX field and its entries in a continuous section of their own with the columns asked for (space 720), the section after it continuous with the columns it had; mid-paragraph, the paragraph is split there.

IsValidEntry(string?)

Gets whether a text can be an index entry: 1 to 255 characters after trimming, without quotes, colons, backslashes or control characters.

MarkIndexEntry(WordDocument, DocumentPosition, IndexEntryOptions)

Marks an index entry at a position, as one undoable edit (Word's Mark Entry): XE "Main:Sub" with \t, \b and \i, a field with no result, placed where the marked text ends.