The RenderIndex type exposes the following members.
Methods
Name | Description | |||
---|---|---|---|---|
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.) |
|||
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.) |
|||
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.) |
|||
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).) |
|||
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.) |
|||
Clone()()()() |
Clones the current RenderObject.
(Inherited from RenderObject.) |
|||
Clone(Boolean, Boolean) |
Clones the current RenderObject.
(Inherited from RenderObject.) |
|||
Clone(Boolean, Boolean, Boolean, Boolean) |
Clones the current RenderObject.
(Inherited from RenderObject.) |
|||
Clone(Boolean, Boolean, Boolean, Boolean, Boolean, Boolean) |
Clones the current RenderObject.
(Inherited from RenderObject.) |
|||
CreateDataBindingCopy |
For internal use.
(Inherited from RenderObject.) |
|||
GetAmbientPropValueForChild |
Gets the value of a child's ambient style property.
(Inherited from RenderObject.) |
|||
GetApproximateCountOfFragmentsToProcess |
Returns the approximate count of fragments in the current object
(used to show progress during document generation).
(Inherited from RenderObject.) |
|||
GetAssignChildren |
Override this method and return false if you want manually copy of children
objects for this object. This method returns true by default.
(Inherited from RenderObject.) |
|||
GetCalculatedValue(Int32) |
For internal use.
(Inherited from RenderObject.) |
|||
GetCalculatedValue(Int32, Object%) |
For internal use.
(Inherited from RenderObject.) |
|||
GetDataBindingForChild |
Returns the C1DataBinding object for a specified child object.
(Inherited from RenderObject.) |
|||
GetDefaultClip |
Gets the default value for the Clip property.
(Inherited from RenderObject.) |
|||
GetDefaultFlags |
Gets the default value for the Flags property.
(Inherited from RenderArea.) |
|||
GetDefaultHeight |
Gets the default value for the Height property.
(Inherited from RenderObject.) |
|||
GetDefaultSplitHorzBehavior |
Gets the default horizontal split behavior (area is too wide).
(Inherited from RenderArea.) |
|||
GetDefaultSplitVertBehavior |
Gets the default vertical split behavior (area is too high).
(Inherited from RenderArea.) |
|||
GetDefaultWidth |
Gets the default area width.
(Inherited from RenderArea.) |
|||
GetDocumentLocationDescription |
Returns a human-readable textual description of the location of the current object in the document.
(Inherited from RenderObject.) |
|||
GetFlag |
Returns the value of flag. The object has private field:
(Inherited from RenderObject.) Copy CodeC#
Copy CodeC#
|
|||
GetHeight |
Override this method to perform additional actions when value of the Height property of object is being read.
(Inherited from RenderObject.) |
|||
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.) |
|||
GetNonAmbientPropValueForChild |
Gets the value of a child's non-ambient style property.
(Inherited from RenderObject.) |
|||
GetOwnedObjectCount |
Calculates the number of objects which are owned by the current object.
(Inherited from RenderObject.) |
|||
GetProcessChildrenWhenDataBindingResolved |
Indicates whether to automatically process data binding on child objects.
The default implementation returns true,
override it and return false if custom child data binding processing
is required.
(Inherited from RenderObject.) |
|||
GetWidth |
Override this method to perform additional actions when value of the Width property of object is being read.
(Inherited from RenderObject.) |
|||
HasCalculatedValue |
For internal use.
(Inherited from RenderObject.) |
|||
IndexOfFragment |
Returns the index of the specified RenderFragment of the current object
in the Fragments collection.
(Inherited from RenderObject.) |
|||
InitRenderObject |
Initializes the current RenderIndex object.
(Overrides RenderObject..::..InitRenderObject()()()().) |
|||
InternalClearCalculatedValues |
Clears the values of calculated properties, called when a document is regenerated.
(Inherited from RenderObject.) |
|||
InternalClearTemporaryInfo |
Clears temporary information created during document resolving.
Override this method to clear render object type-specific data
(but call the base method to clear common data).
(Inherited from RenderObject.) |
|||
InternalResetLayoutDimensions |
For internal use only.
(Inherited from RenderObject.) |
|||
InternalResolveCalculatedValues |
Resolves the values of calculated fields of object.
(Inherited from RenderObject.) |
|||
InternalResolveStyles |
Resolves the calculated values of object's style.
(Inherited from RenderObject.) |
|||
InternalResolvingFinished |
This method is called once after the current RenderObject has been fully resolved.
At the time of the call all RenderFragment objects a built and placed on their pages.
Override it to perform custom processing at that time.
(Inherited from RenderObject.) |
|||
OnChildAdd |
Called after adding new child RenderObject object to the Children collection.
User can throw exception if this object can't be added as the child for this object.
(Inherited from RenderObject.) |
|||
OnChildRemove |
Called after removing child RenderObject object from the Children collection.
User can throw exception if this object can't be removed.
(Inherited from RenderObject.) |
|||
OnMainFragmentBuilt |
This method is called once for each object,
override it to perform custom initialization.
(Inherited from RenderObject.) |
|||
OnParentAdd |
Called after adding this object to the Children collection
of another object.
User can throw exception if this object can't be added as the child for this object.
(Inherited from RenderObject.) |
|||
OnParentRemove |
Called after removing this object from the Children collection
of another object.
(Inherited from RenderObject.) |
|||
ResolveChildrenDataBinding |
Internal use only.
(Inherited from RenderObject.) |
|||
ResolveStyleProperties |
For internal use only.
Resolves calculated properties of the Style()()()() object.
(Inherited from RenderObject.) |
|||
SetCalculatedValue(Int32, Object) |
For internal use.
(Inherited from RenderObject.) |
|||
SetCalculatedValue(Int32, Object, Boolean) |
For internal use.
(Inherited from RenderObject.) |
|||
SetFlag |
Sets value of flag.
(Inherited from RenderObject.) |
|||
SetHeight |
Override this method to perform additional actions when value of the Height property of object is being defined.
(Inherited from RenderObject.) |
|||
SetSplitHorzBehavior |
Override this method to perform additional actions when value of the SplitHorzBehavior property of object is being defined.
(Inherited from RenderObject.) |
|||
SetSplitVertBehavior |
Override this method to perform additional actions when value of the SplitVertBehavior property of object is being defined.
(Inherited from RenderObject.) |
|||
SetWidth |
Override this method to perform additional actions when value of the Width property of object is being defined.
(Inherited from RenderObject.) |
|||
ShouldSerializeChildren |
Tests whether the Children property should be serialized.
(Inherited from RenderObject.) |
|||
ShouldSerializeClip |
Tests whether the Clip property should be serialized.
(Inherited from RenderObject.) |
|||
ShouldSerializeEntryHangingIndent |
Tests whether the EntryHangingIndent property should be serialized.
|
|||
ShouldSerializeEntryIndent |
Tests whether the EntryIndent property should be serialized.
|
|||
ShouldSerializeFlags |
Tests whether the Flags property should be serialized.
(Inherited from RenderObject.) |
|||
ShouldSerializeHeadingStyle |
Tests whether the HeadingStyle property should be serialized.
|
|||
ShouldSerializeHeight |
Tests whether the Height property should be serialized.
(Inherited from RenderObject.) |
|||
ShouldSerializeLetterFormat |
Tests whether the LetterFormat property should be serialized.
|
|||
ShouldSerializeName |
Tests whether the Name property should be serialized.
(Inherited from RenderObject.) |
|||
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.
|
|||
ShouldSerializeSplitHorzBehavior |
Tests whether the SplitHorzBehavior property should be serialized.
(Inherited from RenderObject.) |
|||
ShouldSerializeSplitVertBehavior |
Tests whether the SplitVertBehavior property should be serialized.
(Inherited from RenderObject.) |
|||
ShouldSerializeStyle |
Tests whether the Style()()()() property should be serialized.
(Inherited from RenderObject.) |
|||
ShouldSerializeTermDelimiter |
Tests whether the TermDelimiter property should be serialized.
|
|||
ShouldSerializeWidth |
Tests whether the Width property should be serialized.
(Inherited from RenderObject.) |
|||
ShouldSerializeX |
Tests whether the X property should be serialized.
(Inherited from RenderObject.) |
|||
ShouldSerializeY |
Tests whether the Y property should be serialized.
(Inherited from RenderObject.) |
Properties
Name | Description | |
---|---|---|
Anchors |
Gets the collection of anchors (elements of the type C1Anchor) associated with the current object.
(Inherited from RenderObject.) |
|
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.) |
|
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.) |
|
BreakAfter |
Gets or sets the type of break (none, line, column, or page) to insert after the current object.
(Inherited from RenderObject.) |
|
BreakBefore |
Gets or sets the type of break (none, line, column, or page) to insert before the current object.
(Inherited from RenderObject.) |
|
CanSplitHorz | Obsolete.
Indicates whether the object can be split horizontally if it falls on a page break.
(Inherited from RenderObject.) |
|
CanSplitVert | Obsolete.
Indicates whether the object can be split vertically if it falls on a page break.
(Inherited from RenderObject.) |
|
Children |
Gets the collection of child render objects.
(Inherited from RenderObject.) |
|
Clip |
Gets or sets the value indicating whether the object should be clipped.
(Inherited from RenderObject.) |
|
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.) |
|
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.) |
|
DataBinding |
Gets an instance of C1DataBinding class representing the
data binding properties of the current object.
(Inherited from RenderObject.) |
|
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.) |
|
DataBindingMode |
Gets a combination of DataBindingModeEnum flags
specifying the data binding mode of the current object.
(Inherited from RenderObject.) |
|
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 ('.'). |
|
FirstFragment |
Gets the first fragment of the current object,
or null if Fragments has not been initialized yet.
(Inherited from RenderObject.) |
|
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.) |
|
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.) |
|
Fragments |
Gets a RenderFragmentCollection containing the fragments
produced by the current object in the generated document.
(Inherited from RenderObject.) |
|
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.) |
|
HasChildren |
Gets a value indicating whether the current object has children
(i.e. its Children collection contains at least one element).
(Inherited from RenderObject.) |
|
HasEntries |
Gets a value indicating whether the Entries collection
has been created and contains one or more elements.
|
|
HasFragments |
Gets a value indicating whether the current object's Fragments
collection has been initialized and contains one or more fragments.
(Inherited from RenderObject.) |
|
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.) |
|
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.) |
|
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.)
|
|
Height |
Gets or sets the height of the current object.
(Inherited from RenderObject.)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"). |
|
Hyperlink |
Gets or sets the hyperlink (see C1Hyperlink) associated with the current object.
(Inherited from RenderObject.) |
|
IndexInOwner |
Gets the index of the current object within the Owner()()()(), or -1 if there is no owner.
(Inherited from RenderObject.) |
|
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.) |
|
LastFragment |
Gets the last fragment of the current object,
or null if Fragments has not been initialized yet.
(Inherited from RenderObject.) |
|
LayoutChangeAfter |
Gets or sets the LayoutChangeBase object
defining the change of page layout that will occur after the current object.
(Inherited from RenderObject.) |
|
LayoutChangeBefore |
Gets or sets the LayoutChangeBase object
defining the change of page layout that will occur before the current object.
(Inherited from RenderObject.) |
|
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
|
|
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.) |
|
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.) |
|
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). |
|
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.) |
|
PageNumberingChange |
Gets or sets the PageNumberingChange object
defining the page numbering change that will occur when the current object is rendered.
(Inherited from RenderObject.) |
|
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}". |
|
Parent |
Gets the parent RenderObject containing the current object.
(Inherited from RenderObject.) |
|
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. |
|
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.) |
|
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.) |
|
Stacking |
Gets or sets the stacking rules used to arrange the children of the current object.
(Inherited from RenderObject.) |
|
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.) |
|
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.) |
|
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.) |
|
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.) |
|
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). |
|
UserData |
Gets or sets arbitrary data associated with the current object.
(Inherited from RenderObject.) |
|
Visibility |
Gets or sets a value indicating the visibility of the current object.
(Inherited from RenderObject.) |
|
Width |
Gets or sets the width of the current object.
(Inherited from RenderObject.)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)"). |
|
X |
Gets or sets the X coordinate of the current object.
(Inherited from RenderObject.)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"). |
|
Y |
Gets or sets the Y coordinate of the current object.
(Inherited from RenderObject.)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"). |
|
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.) |
Explicit Interface Implementations
Name | Description | |
---|---|---|
IDocumentLocation..::..PageIndex | (Inherited from RenderObject.) | |
IDocumentLocation..::..PageNo | (Inherited from RenderObject.) | |
ISplitBehaviorObject..::..GetPageBounds | (Inherited from RenderObject.) | |
ISplitBehaviorObject..::..RenderObject | (Inherited from RenderObject.) | |
IStyleOwner..::..GetProp | (Inherited from RenderObject.) | |
IStyleOwner..::..GetAmbientPropValue | (Inherited from RenderObject.) | |
IStyleOwner..::..GetNonAmbientPropValue | (Inherited from RenderObject.) |