[]
        
(Showing Draft Content)

GrapeCity.Documents.Word.Fields.IndexEntry

IndexEntry Class

Represents a multi-level index entry.

Inheritance
IndexEntry
Namespace: GrapeCity.Documents.Word.Fields
Assembly: DS.Documents.Word.dll
Syntax
public class IndexEntry
Public Class IndexEntry

Properties

Name Description
Content

Gets the formatted content of the index entry.

Level

Gets the level of the index entry.

Parent

Gets the parent index entry.

SortBy

Gets or sets the string to sort entry in the INDEX field result.

The value of this property is invisible in the INDEX field result but allows changing the index entry sorting order.

Note that entries with the same GrapeCity.Documents.Word.Fields.IndexEntry.Text but different SortBy values are not grouped together.

Default value is null.

SubEntry

Gets the sub index entry.

Yomi

Gets or sets the yomi (first phonetic character for sorting indexes) for the index entry.

While the GrapeCity.Documents.Word.Fields.IndexEntry.Text property may contain a word's spelling in Kanji, whose pronunciation may be ambiguous, the "Yomi" version of the word will spell exactly how it is pronounced using Hiragana.

Default value is space for the first and last level. For other levels default value is Empty.

Methods

Name Description
AddSubEntry(string)

Adds a sub index entry.

AddSubEntry(string, string)

Adds a sub index entry.

RemoveSubEntry()

Removes the sub index entry.

If the sub entry has its own sub entry, it becomes the sub entry for this entry.

ToString()