[]
DEMOS DOCS API SAMPLES DOWNLOAD
(Showing Draft Content)

C1.C1Preview.RenderIndex

RenderIndex Class

Represents an alphabetical, optionally multi-level, word index in a C1PrintDocument.

Inheritance
object
RenderObject
RenderArea
RenderIndex
Implements
Namespace: C1.C1Preview
Assembly: C1.PrintDocument.8.dll
Syntax
[C1ClassSerialization(true)]
public class RenderIndex : RenderArea, IStyleOwner, IDocumentLocation
Remarks

To create an index, follow these steps:

  • Create an instance of the RenderIndex class, store it in a local variable.
  • For each index entry, create an instance of the IndexEntry class.
  • For each occurrence of each index entry in the document, create an instance of the IndexEntryOccurrence class, and set the Target on it to point to the location of that occurrence in the document.
  • After all occurrences have been added to their entries, and all entries have been added to the Entries, add the RenderIndex object created in the first step, to the document. When the document generates, that object will create the alphabetically sorted word index with clickable page numbers.

Constructors

Name Description
RenderIndex()

Initializes a new instance of the RenderIndex class.

Properties

Name Description
Entries

Gets the collection of entries (elements of type IndexEntry) at the top level of the current index.
EntryHangingIndent

Gets or sets the hanging indent of the first line of an entry's paragraph relative to the following lines (used if the list of occurrences and cross-references for the entry is too long to fit on a single line).

The default is 1/8 of an inch.
EntryIndent

Gets or sets the indent of sub-entries relative to the main index entry.

The default is 1/4 of an inch.
EntrySplitBehavior

Determines how a single entry can split vertically. This property applies to entries at all levels.

The default is SplitIfLarge.
EntryStyle

Gets the style of index entries at the top level. This is a shortcut to the first (with index 0) element of the EntryStyles collection.
EntryStyles

Gets the IndexEntryStyles collection containing the styles used to render entries of the current RenderIndex at different levels.
FillChar

Gets or sets a character used to fill the empty space between an index entry's Caption and the page number or numbers referencing the occurrences of that entry. This property is only used if PageNumbersAtRight on the current RenderIndex has been set to true.

The default is a dot ('.').
HasEntries

Gets a value indicating whether the Entries collection has been created and contains one or more elements.
HeadingStyle

Gets the Style used for letter headings generated by the current index. (A heading is a letter preceding the group of entries beginning with that letter.)
LetterFormat

Gets or sets a string used to format the letter group headings.

The default is "{0}".
LetterSplitBehavior

Gets or sets a SplitBehaviorEnum that determines how a letter group (entries starting with the same letter) can split vertically. The default is SplitIfNeeded. Note that headings (represented by their letters by default) are always printed together with their first entry
OccurrenceDelimiter

Gets or sets a string used to delimit the occurrences (page numbers) of an index entry in the generated index.

The default is ", " (comma followed by space).
PageNumbersAtRight

Gets or sets a value indicating whether page numbers in the generated index should be right-aligned.

The default is false.
PageRangeFormat

Gets or sets a format string used to format the page ranges of occurrences of index entries in the generated index.

The default is "{0}-{1}".
RunIn

Gets or sets a value indicating whether that sub-entries should appear inline with the main heading rather than on separate indented lines.

The default is false.
RunInDelimiter

Gets or sets a string used to delimit entries when a run-in (see RunIn) index is generated by the current RenderIndex.

The default is ";" (semicolon).
SeeAlsoFormat

Gets or sets a format string used to format the "See also" cross-references in the generated index.

The default is "(see {0})".
SeeAlsoStyle

Gets the Style of the "See (...)" text used to list cross-references between entries of the current RenderIndex.

Note that this style is only applied to the static text of the SeeAlsoFormat format string, but not to the entries' list output by that format.

TermDelimiter

Gets or sets a string used to delimit an index entry and the list of that entry's occurrences (page numbers) in the generated index.

The default is ", " (comma followed by space).

Methods

Name Description
AssignFrom(RenderObject, bool, bool, bool, bool, bool, bool)

Assigns (copies) properties from another RenderObject to the current object. Calls the base AssignFrom(RenderObject, bool, bool, bool, bool, bool, bool) method. If source is a RenderIndex, also copies RenderIndex-specific properties.
CreateSame()

Creates new empty RenderArea object linked with same C1PrintDocument as current object.
InitRenderObject()

Initializes the current RenderIndex object.
ShouldSerializeEntryHangingIndent()

Tests whether the EntryHangingIndent property should be serialized.
ShouldSerializeEntryIndent()

Tests whether the EntryIndent property should be serialized.
ShouldSerializeHeadingStyle()

Tests whether the HeadingStyle property should be serialized.
ShouldSerializeLetterFormat()

Tests whether the LetterFormat property should be serialized.
ShouldSerializeOccurrenceDelimiter()

Tests whether the OccurrenceDelimiter property should be serialized.
ShouldSerializePageRangeFormat()

Tests whether the PageRangeFormat property should be serialized.
ShouldSerializeRunInDelimiter()

Tests whether the RunInDelimiter property should be serialized.
ShouldSerializeSeeAlsoFormat()

Tests whether the SeeAlsoFormat property should be serialized.
ShouldSerializeSeeAlsoStyle()

Tests whether the SeeAlsoStyle property should be serialized.
ShouldSerializeTermDelimiter()

Tests whether the TermDelimiter property should be serialized.

See Also