The RenderIndex type exposes the following members.

Methods

  Name Description
Public method AssignFrom(RenderObject)
Assigns (copies) properties from another RenderObject to the current object. The list of fragments (the Fragments property) is neither copied nor changed. Properties UserData, PageNumberingChange are copied by reference. The Name property is not copied.
(Inherited from RenderObject.)
Public method AssignFrom(RenderObject, Boolean, Boolean)
Assigns (copies) properties from another RenderObject to the current object. The list of fragments (the Fragments property) is neither copied nor changed. Properties UserData, PageNumberingChange are copied by reference. The Name property is not copied.
(Inherited from RenderObject.)
Public method AssignFrom(RenderObject, Boolean, Boolean, Boolean, Boolean)
Assigns (copies) properties from another RenderObject to the current object. The list of fragments (the Fragments property) is neither copied nor changed. Properties UserData, PageNumberingChange are copied by reference. The Name property is not copied.
(Inherited from RenderObject.)
Public method AssignFrom(RenderObject, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)
Assigns (copies) properties from another RenderObject to the current object. Calls the base AssignFrom(RenderObject, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean) method. If source is a RenderIndex, also copies RenderIndex-specific properties.
(Overrides RenderArea..::..AssignFrom(RenderObject, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean).)
Public method CalcSize
Calculates the size of the current object. When this method is called, the object must already have been added to the document (e.g. to Body or to Children of another object in the document). See remarks for more details.
(Inherited from RenderObject.)
Public method Clone()()()()
Clones the current RenderObject.
(Inherited from RenderObject.)
Public method Clone(Boolean, Boolean)
Clones the current RenderObject.
(Inherited from RenderObject.)
Public method Clone(Boolean, Boolean, Boolean, Boolean)
Clones the current RenderObject.
(Inherited from RenderObject.)
Public method Clone(Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)
Clones the current RenderObject.
(Inherited from RenderObject.)
Public method GetNestedObjectCount
Calculates the count of objects which are nested within this object. This method takes into account child objects and their children.
(Inherited from RenderObject.)
Public method GetOwnedObjectCount
Calculates the number of objects which are owned by the current object.
(Inherited from RenderObject.)
Public method IndexOfFragment
Returns the index of the specified RenderFragment of the current object in the Fragments collection.
(Inherited from RenderObject.)

Properties

  Name Description
Public property Anchors
Gets the collection of anchors (elements of the type C1Anchor) associated with the current object.
(Inherited from RenderObject.)
Public property BordersSplitHorzMode
Gets or sets a value indicating how borders are drawn if the object is too wide and is split between horizontal pages.
(Inherited from RenderObject.)
Public property BordersSplitVertMode
Gets or sets a value indicating how borders are drawn if the object is too high and is split between pages.
(Inherited from RenderObject.)
Public property BreakAfter
Gets or sets the type of break (none, line, column, or page) to insert after the current object.
(Inherited from RenderObject.)
Public property BreakBefore
Gets or sets the type of break (none, line, column, or page) to insert before the current object.
(Inherited from RenderObject.)
Public property CanSplitHorz Obsolete.
Indicates whether the object can be split horizontally if it falls on a page break.
(Inherited from RenderObject.)
Public property CanSplitVert Obsolete.
Indicates whether the object can be split vertically if it falls on a page break.
(Inherited from RenderObject.)
Public property Children
Gets the collection of child render objects.
(Inherited from RenderObject.)
Public property Clip
Gets or sets the value indicating whether the object should be clipped.
(Inherited from RenderObject.)
Public property Collection
Gets the RenderObjectCollection containing the current object, or null if the current object has no Owner()()()() or the owner is not a RenderObjectCollection.
(Inherited from RenderObject.)
Public property Copies
Gets the collection of RenderObject objects generated by data binding. The value of this property is null if the object is not data bound.
(Inherited from RenderObject.)
Public property DataBinding
Gets an instance of C1DataBinding class representing the data binding properties of the current object.
(Inherited from RenderObject.)
Public property DataBindingDefined
Gets a value indicating whether the current object is data bound. Returns true if the object's DataBinding property has been initialized and its Mode is not None.
(Inherited from RenderObject.)
Public property DataBindingMode
Gets a combination of DataBindingModeEnum flags specifying the data binding mode of the current object.
(Inherited from RenderObject.)
Public property Document
Gets the C1PrintDocument object containing the current RenderObject.
(Inherited from RenderObject.)
Public property Entries
Gets the collection of entries (elements of type IndexEntry) at the top level of the current index.
Public property 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.

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

The default is 1/4 of an inch.

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

The default is SplitIfLarge.

Public property 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.
Public property EntryStyles
Gets the IndexEntryStyles collection containing the styles used to render entries of the current RenderIndex at different levels.
Public property 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 ('.').

Public property FirstFragment
Gets the first fragment of the current object, or null if Fragments has not been initialized yet.
(Inherited from RenderObject.)
Public property FormatDataBindingInstanceScript
Gets or sets a script that is executed each time a new instance of the current RenderObject is created due to data binding resolving.
(Inherited from RenderObject.)
Public property FragmentResolvedScript
Gets or sets the script that is executed each time a RenderFragment of the current render object is created and added to the Fragments collection on the current object.
(Inherited from RenderObject.)
Public property Fragments
Gets a RenderFragmentCollection containing the fragments produced by the current object in the generated document.
(Inherited from RenderObject.)
Public property HasAnchors
Gets a value indicating whether the current object has any anchors associated with it (i.e. whether the Anchors collection exists and is not empty).
(Inherited from RenderObject.)
Public property HasChildren
Gets a value indicating whether the current object has children (i.e. its Children collection contains at least one element).
(Inherited from RenderObject.)
Public property HasEntries
Gets a value indicating whether the Entries collection has been created and contains one or more elements.
Public property HasFragments
Gets a value indicating whether the current object's Fragments collection has been initialized and contains one or more fragments.
(Inherited from RenderObject.)
Public property HeaderHorz
Gets or sets a RenderObject that will be repeated on all "horizontal" pages if the current render area is split horizontally when it is too wide to fit on a single page.
(Inherited from RenderArea.)
Public property HeaderVert
Gets or sets a RenderObject that is repeated on all pages (or columns) if the current render area is split vertically when it is too high to fit on a single page.
(Inherited from RenderArea.)
Public property 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.)
Public property Height
Gets or sets the height of the current object.

May be specified as auto (Auto), a percentage of the parent's height (e.g. "50%"), an absolute value (using DefaultUnit), an absolute value with unit of measurement (e.g. "12mm"), or an expression referencing this and other objects (e.g. "150%prev.height+1in").

(Inherited from RenderObject.)
Public property Hyperlink
Gets or sets the hyperlink (see C1Hyperlink) associated with the current object.
(Inherited from RenderObject.)
Public property IndexInOwner
Gets the index of the current object within the Owner()()()(), or -1 if there is no owner.
(Inherited from RenderObject.)
Public property KeepTogether
Gets or sets a render object which should be printed on the same page as the current object. The specified object must have the same Parent as the current object.
(Inherited from RenderObject.)
Public property LastFragment
Gets the last fragment of the current object, or null if Fragments has not been initialized yet.
(Inherited from RenderObject.)
Public property LayoutChangeAfter
Gets or sets the LayoutChangeBase object defining the change of page layout that will occur after the current object.
(Inherited from RenderObject.)
Public property LayoutChangeBefore
Gets or sets the LayoutChangeBase object defining the change of page layout that will occur before the current object.
(Inherited from RenderObject.)
Public property LetterFormat
Gets or sets a string used to format the letter group headings.

The default is "{0}".

Public property 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
Public property Name
Gets or sets the name of the current object. The name can be an empty string. If it is not empty, the name must be unique among the current object's siblings (i.e. objects with the same Owner()()()()).
(Inherited from RenderObject.)
Public property ObjectResolvedScript
Gets or sets the script that is executed when the current object has been completely resolved, all its fragments created and added to the Fragments collection of the current object.
(Inherited from RenderObject.)
Public property 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).

Public property Original
Gets the original RenderObject object that produced the current object during data binding, or null if there is no such object.
(Inherited from RenderObject.)
Public property PageNumberingChange
Gets or sets the PageNumberingChange object defining the page numbering change that will occur when the current object is rendered.
(Inherited from RenderObject.)
Public property PageNumbersAtRight
Gets or sets a value indicating whether page numbers in the generated index should be right-aligned.

The default is false.

Public property 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}".

Public property Parent
Gets the parent RenderObject containing the current object.
(Inherited from RenderObject.)
Public property 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.

Public property 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).

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

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

Public property 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.

Public property SplitHorzBehavior
Gets or sets the value determining how the object is treated when it is too wide to fit in the horizontal space available on the current page.
(Inherited from RenderObject.)
Public property SplitVertBehavior
Gets or sets the value determining how the object is treated when it is too high to fit in the vertical space available on the current page.
(Inherited from RenderObject.)
Public property Stacking
Gets or sets the stacking rules used to arrange the children of the current object.
(Inherited from RenderObject.)
Public property Style
Gets the Style of the current object. This property cannot be assigned to. To use another style as the base for the current object's style, set the Parent to that other style.
(Inherited from RenderObject.)
Public property Table
Gets the most nested RenderTable containing the current render object, or null if the current object is not contained in a table.
(Inherited from RenderObject.)
Public property TableCell
Gets the TableCell object containing the current object, or null if the current object is not contained in a cell of a RenderTable.
(Inherited from RenderObject.)
Public property TableCol
Gets the 0-based index of the column in the most nested RenderTable containing the current render object, or -1 if the current object is not contained in a table.
(Inherited from RenderObject.)
Public property TableRow
Gets the 0-based index of the row in the most nested RenderTable containing the current render object, or -1 if the current object is not contained in a table.
(Inherited from RenderObject.)
Public property 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).

Public property UserData
Gets or sets arbitrary data associated with the current object.
(Inherited from RenderObject.)
Public property Visibility
Gets or sets a value indicating the visibility of the current object.
(Inherited from RenderObject.)
Public property Width
Gets or sets the width of the current object.

May be specified as auto (Auto), a percentage of the parent's width (e.g. "50%"), an absolute value (using DefaultUnit), an absolute value with unit of measurement (e.g. "12mm"), or an expression referencing this and other objects (e.g. "Max(prev.width,6cm)").

(Inherited from RenderObject.)
Public property X
Gets or sets the X coordinate of the current object.

May be specified as auto (Auto), an absolute value (using DefaultUnit), an absolute value with unit of measurement (e.g. "12mm"), or an expression referencing this and other objects (e.g. "prev.right+2mm").

(Inherited from RenderObject.)
Public property Y
Gets or sets the Y coordinate of the current object.

May be specified as auto (Auto), an absolute value (using DefaultUnit), an absolute value with unit of measurement (e.g. "12mm"), or an expression referencing this and other objects (e.g. "prev.height/2-self.height/2").

(Inherited from RenderObject.)
Public property ZOrder
Gets or sets the Z-order of the current object. Objects with smaller Z-order values are drawn under objects with larger Z-order values. By default, this property is zero.
(Inherited from RenderObject.)

See Also