The IndexEntry type exposes the following members.

Constructors

  Name Description
Public method IndexEntry()()()()
Initializes a new instance of the IndexEntry class.
Public method IndexEntry(String)
Initializes a new instance of the IndexEntry class.
Public method IndexEntry(String, array<C1LinkTarget>[]()[][])
Initializes a new instance of the IndexEntry class.
Public method IndexEntry(String, array<IndexEntryOccurrence>[]()[][])
Initializes a new instance of the IndexEntry class.

Methods

  Name Description
Public method AssignFrom
Assigns (copies) properties from another IndexEntry to the current object.
Public method Clone
Creates a copy of the current IndexEntry object.

Properties

  Name Description
Public property Caption
Gets or sets the string that will represent the current index entry in the generated index.
Public property Children
Gets the IndexEntryCollection containing the nested index entries, i.e. sub-entries of the current index entry.
Public property Document
Gets the C1PrintDocument object containing the current index entry.
Public property HasChildren
Gets a value indicating whether the Children collection has been created and contains one or more elements.
Public property HasOccurrences
Gets a value indicating whether the Occurrences collection has been created and contains one or more elements.
Public property HasSeeAlso
Gets a value indicating whether the SeeAlso collection has been created and contains one or more elements.
Public property Level
Gets the level of the current index entry. The top-level entries' level is 0, sub-entries' level is 1, and so on. If the current index entry has not been added to a RenderIndex object or to a nested entry of such object, this property returns -1. or to an IndexEntry
Public property Occurrences
Gets the List<(Of <(<'T>)>)> of IndexEntryOccurrence objects representing occurrences of the current index entry in the document. In the generated index, each occurrence is replaced by the page number, which is a hyperlink to the occurrence's location in the document. (Consecutive page numbers are collapsed to ranges.)
Public property RenderIndex
Gets the RenderIndex object containing the current index entry at some level, either at a top-level entry or a nested entry.
Public property SeeAlso
Gets the List<(Of <(<'T>)>)> of IndexEntry objects related to the current index entry. In the generated index, those entries will be listed as "See also" cross-references from the current to other entries.
Public property SeeAlsoStyle
Gets the Style for the current index entry's "See also" references (see SeeAlso).

Explicit Interface Implementations

See Also