The following specialized classes support indexing:
• RenderIndex: This class is derived from RenderArea, and produces the index when inserted in a C1PrintDocument and that document generates.
• The RenderIndex must appear in the document after all occurrences of the index entries. The reason for this limitation is that the actual content of the index (and hence, the amount of space occupied by it) may vary significantly depending on the occurrences of the entries.
• IndexEntry: This class is used to describe an index entry (term) in the index.
• Each entry can have multiple occurrences (locations in the document where the term is described or referenced) associated with it. The collection of all occurrences of an entry is exposed via the Occurrences property on the IndexEntry.
• Each occurrence will produce a hyperlinked page number in the index when the document is generated. Besides which, an entry may contain a list of sub-entries (exposed by the property Children). The nesting level is unlimited, though usually up to 3 levels are used.
• Finally, to allow linking an entry to other entries in the index, the SeeAlso property on the entry contains a list of index entries that will be listed as references for the current entry in the generated index.
• IndexEntryOccurrence: This class describes a single occurrence of an entry in the document.
• Elements of this type are contained in the Occurrences collection of an IndexEntry.
• One or more occurrences can be specified (as parameters to the constructor) when an instance of an index entry is created, and more occurrences can be added to the entry later.
• The main functional property of this class is Target, of the type C1LinkTarget, which points to the location of the occurrence.
|
