API Reference
WordIndexEntry
Describes a generated index entry.
Inheritance
- Object
- WordIndexEntry
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property WordIndexRefreshReport.Entries
Inherited Methods
Properties
public String Subterm { get; } #Gets the optional first-level subentry. For deeper entries, use Subterms.
public IReadOnlyList<String> Subterms { get; } #Gets all subentry levels under the main term.
public IReadOnlyList<String> Path { get; } #Gets the complete index path, including the main term and every subentry level.
public String CrossReferenceText { get; } #Gets the cross-reference text for entries such as "See another term".
public String EntryType { get; } #Gets the optional Word index entry type from the XE \f switch.
public Boolean IsCrossReference { get; } #Gets whether this entry renders as a cross-reference instead of page numbers.
public IReadOnlyList<Int32> PageNumbers { get; } #Gets estimated page numbers collected for the entry.
public IReadOnlyList<String> PageReferences { get; } #Gets estimated page references collected for the entry, including bookmark page ranges such as 1-2.
public String PageNumbersText { get; } #Gets page numbers and page ranges formatted for display.