| Name | Description | |
|---|---|---|
 | RenderIndex Constructor | Initializes a new instance of the RenderIndex class. |
The following tables list the members exposed by RenderIndex.
| Name | Description | |
|---|---|---|
| RenderIndex Constructor | Initializes a new instance of the RenderIndex class. |
| Name | Description | |
|---|---|---|
 | Anchors | Gets the collection of anchors (elements of the type C1Anchor) associated with the current object. (Inherited from C1.C1Preview.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 C1.C1Preview.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 C1.C1Preview.RenderObject) |
| BreakAfter | Gets or sets the type of break (none, line, column, or page) to insert after the current object. (Inherited from C1.C1Preview.RenderObject) |
| BreakBefore | Gets or sets the type of break (none, line, column, or page) to insert before the current object. (Inherited from C1.C1Preview.RenderObject) |
| CanSplitHorz | Indicates whether the object can be split horizontally if it falls on a page break. (Inherited from C1.C1Preview.RenderObject) |
| CanSplitVert | Indicates whether the object can be split vertically if it falls on a page break. (Inherited from C1.C1Preview.RenderObject) |
| Children | Gets the collection of child render objects. (Inherited from C1.C1Preview.RenderObject) |
| Clip | Gets or sets the value indicating whether the object should be clipped. (Inherited from C1.C1Preview.RenderObject) |
| Collection | Gets the RenderObjectCollection containing the current object, or null if the current object has no IOwnedCollectionItem.Owner or the owner is not a RenderObjectCollection. (Inherited from C1.C1Preview.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 C1.C1Preview.RenderObject) |
| DataBinding | Gets an instance of C1.C1Preview.DataBinding.C1DataBinding class representing the data binding properties of the current object. (Inherited from C1.C1Preview.RenderObject) |
| DataBindingDefined | Gets a value indicating whether the current object is data bound. Returns true if the object's RenderObject.DataBinding property has been initialized and its C1.C1Preview.DataBinding.C1DataBinding.Mode is not DataBindingModeEnum.None. (Inherited from C1.C1Preview.RenderObject) |
| DataBindingMode | Gets a combination of DataBindingModeEnum flags specifying the data binding mode of the current object. (Inherited from C1.C1Preview.RenderObject) |
| Document | Gets the C1PrintDocument object containing the current RenderObject. (Inherited from C1.C1Preview.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 SplitBehaviorEnum.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 IndexEntry.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 ('.'). |
| FireProgressEvent | TBD: Gets or sets a value indicating whether progress events should be generated during resolving of this render object. This property is false by default, you can set this property to true if object is large and its resolving take a long of time, to suppress hangup time during document rendering. (Inherited from C1.C1Preview.RenderObject) |
| FirstFragment | Gets the first fragment of the current object, or null if RenderObject.Fragments has not been initialized yet. (Inherited from C1.C1Preview.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 C1.C1Preview.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 RenderObject.Fragments collection on the current object. (Inherited from C1.C1Preview.RenderObject) |
| Fragments | Gets a RenderFragmentCollection containing the fragments produced by the current object in the generated document. (Inherited from C1.C1Preview.RenderObject) |
| HasAnchors | Gets a value indicating whether the current object has any anchors associated with it (i.e. whether the RenderObject.Anchors collection exists and is not empty). (Inherited from C1.C1Preview.RenderObject) |
| HasChildren | Gets a value indicating whether the current object has children (i.e. its RenderObject.Children collection contains at least one element). (Inherited from C1.C1Preview.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 RenderObject.Fragments collection has been initialized and contains one or more fragments. (Inherited from C1.C1Preview.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 C1.C1Preview.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 C1.C1Preview.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.
May be specified as auto (Unit.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 C1.C1Preview.RenderObject) |
| Hyperlink | Gets or sets the hyperlink (see C1Hyperlink) associated with the current object. (Inherited from C1.C1Preview.RenderObject) |
| IndexInOwner | Gets the index of the current object within the IOwnedCollectionItem.Owner, or -1 if there is no owner. (Inherited from C1.C1Preview.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 RenderObject.Parent as the current object. (Inherited from C1.C1Preview.RenderObject) |
| LastFragment | Gets the last fragment of the current object, or null if RenderObject.Fragments has not been initialized yet. (Inherited from C1.C1Preview.RenderObject) |
| LayoutChangeAfter | Gets or sets the LayoutChangeBase object defining the change of page layout that will occur after the current object. (Inherited from C1.C1Preview.RenderObject) |
| LayoutChangeBefore | Gets or sets the LayoutChangeBase object defining the change of page layout that will occur before the current object. (Inherited from C1.C1Preview.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 SplitBehaviorEnum.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 IOwnedCollectionItem.Owner). (Inherited from C1.C1Preview.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 RenderObject.Fragments collection of the current object. (Inherited from C1.C1Preview.RenderObject) |
| ObjectResolvingScript | (Inherited from C1.C1Preview.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 C1.C1Preview.RenderObject) |
| PageNumberingChange | Gets or sets the RenderObject.PageNumberingChange object defining the page numbering change that will occur when the current object is rendered. (Inherited from C1.C1Preview.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 C1.C1Preview.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 C1.C1Preview.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 C1.C1Preview.RenderObject) |
| Stacking | Gets or sets the stacking rules used to arrange the children of the current object. (Inherited from C1.C1Preview.RenderObject) |
| Style | Gets the RenderObject.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 Style.Parent to that other style. (Inherited from C1.C1Preview.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 C1.C1Preview.RenderObject) |
| TableCell | Gets the RenderObject.TableCell object containing the current object, or null if the current object is not contained in a cell of a RenderTable. (Inherited from C1.C1Preview.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 C1.C1Preview.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 C1.C1Preview.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 C1.C1Preview.RenderObject) |
| Visibility | Gets or sets a value indicating the visibility of the current object. (Inherited from C1.C1Preview.RenderObject) |
| Width | Gets or sets the width of the current object.
May be specified as auto (Unit.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 C1.C1Preview.RenderObject) |
| X | Gets or sets the X coordinate of the current object.
May be specified as auto (Unit.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 C1.C1Preview.RenderObject) |
| Y | Gets or sets the Y coordinate of the current object.
May be specified as auto (Unit.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 C1.C1Preview.RenderObject) |
| 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 C1.C1Preview.RenderObject) |
| Name | Description | |
|---|---|---|
 | CalculatedValues | Gets the hashtable containing the calculated values. (Inherited from C1.C1Preview.RenderObject) |
| HasCalculatedValues | Gets a value indicating whether the RenderObject.CalculatedValues hashtable exists and is not empty. (Inherited from C1.C1Preview.RenderObject) |
| m_Flags | For internal use. (Inherited from C1.C1Preview.RenderObject) |
| Name | Description | |
|---|---|---|
 | AssignFrom | Overloaded. Overridden. Assigns (copies) properties from another RenderObject to the current object. Calls the base RenderArea.AssignFrom method. If source is a RenderIndex, also copies RenderIndex-specific properties. |
| 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 RenderObject.Children of another object in the document). See remarks for more details. (Inherited from C1.C1Preview.RenderObject) |
| Clone | Overloaded. Clones the current RenderObject. (Inherited from C1.C1Preview.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 C1.C1Preview.RenderObject) |
| GetOwnedObjectCount | Calculates the number of objects which are owned by the current object. (Inherited from C1.C1Preview.RenderObject) |
| IndexOfFragment | Returns the index of the specified RenderFragment of the current object in the RenderObject.Fragments collection. (Inherited from C1.C1Preview.RenderObject) |
| Name | Description | |
|---|---|---|
 | CreateDataBindingCopy | For internal use. (Inherited from C1.C1Preview.RenderObject) |
| CreateSame | Overridden. |
| GetAmbientPropValueForChild | Gets the value of a child's ambient style property. (Inherited from C1.C1Preview.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 C1.C1Preview.RenderObject) |
| GetDataBindingForChild | Returns the C1.C1Preview.DataBinding.C1DataBinding object for a specified child object. (Inherited from C1.C1Preview.RenderObject) |
| GetDefaultClip | Gets the default value for the RenderObject.Clip property. (Inherited from C1.C1Preview.RenderObject) |
| GetDefaultFlags | Gets the default value for the Flags property. (Inherited from C1.C1Preview.RenderArea) |
| GetDefaultHeight | Gets the default value for the RenderObject.Height property. (Inherited from C1.C1Preview.RenderObject) |
| GetDefaultSplitHorzBehavior | Gets the default horizontal split behavior (area is too wide). (Inherited from C1.C1Preview.RenderArea) |
| GetDefaultSplitVertBehavior | Gets the default vertical split behavior (area is too high). (Inherited from C1.C1Preview.RenderArea) |
| GetDefaultWidth | Gets the default area width. (Inherited from C1.C1Preview.RenderArea) |
| GetDocumentLocationDescription | Returns a human-readable textual description of the location of the current object in the document. (Inherited from C1.C1Preview.RenderObject) |
| GetFlag | Returns the value of flag. The object has private field: private int _flags; This field can be used for storing various boolean properties (CanSplitHorz, CanSplitVert etc), for example CanSplitHorz property defined as: public bool CanSplitHorz { get { return GetFlag(c_flgCanSplitVert); } set { SetFlag(c_flgCanSplitVert, value); } } (Inherited from C1.C1Preview.RenderObject) |
| GetHeight | Override this method to perform additional actions when value of the Height property of object is being read. (Inherited from C1.C1Preview.RenderObject) |
| GetNonAmbientPropValueForChild | Gets the value of a child's non-ambient style property. (Inherited from C1.C1Preview.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 C1.C1Preview.RenderObject) |
| GetWidth | Override this method to perform additional actions when value of the Width property of object is being read. (Inherited from C1.C1Preview.RenderObject) |
| InitRenderObject | Overridden. Initializes the current RenderIndex object. |
| InternalResetLayoutDimensions | For internal use only. (Inherited from C1.C1Preview.RenderObject) |
| InternalResolveCalculatedValues | Resolves the values of calculated fields of object. (Inherited from C1.C1Preview.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 C1.C1Preview.RenderObject) |
| OnMainFragmentBuilt | This method is called once for each object, override it to perform custom initialization. (Inherited from C1.C1Preview.RenderObject) |
| SetFlag | Sets value of flag. (Inherited from C1.C1Preview.RenderObject) |
| SetHeight | Override this method to perform additional actions when value of the Height property of object is being defined. (Inherited from C1.C1Preview.RenderObject) |
| SetSplitHorzBehavior | Override this method to perform additional actions when value of the SplitHorzBehavior property of object is being defined. (Inherited from C1.C1Preview.RenderObject) |
| SetSplitVertBehavior | Override this method to perform additional actions when value of the SplitVertBehavior property of object is being defined. (Inherited from C1.C1Preview.RenderObject) |
| SetWidth | Override this method to perform additional actions when value of the Width property of object is being defined. (Inherited from C1.C1Preview.RenderObject) |
| ShouldSerializeChildren | Tests whether the RenderObject.Children property should be serialized. (Inherited from C1.C1Preview.RenderObject) |
| ShouldSerializeClip | Tests whether the RenderObject.Clip property should be serialized. (Inherited from C1.C1Preview.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 C1.C1Preview.RenderObject) |
| ShouldSerializeHeadingStyle | Tests whether the HeadingStyle property should be serialized. |
| ShouldSerializeHeight | Tests whether the RenderObject.Height property should be serialized. (Inherited from C1.C1Preview.RenderObject) |
| ShouldSerializeLetterFormat | Tests whether the LetterFormat property should be serialized. |
| ShouldSerializeName | Tests whether the RenderObject.Name property should be serialized. (Inherited from C1.C1Preview.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 RenderObject.SplitHorzBehavior property should be serialized. (Inherited from C1.C1Preview.RenderObject) |
| ShouldSerializeSplitVertBehavior | Tests whether the RenderObject.SplitVertBehavior property should be serialized. (Inherited from C1.C1Preview.RenderObject) |
| ShouldSerializeStyle | Tests whether the RenderObject.Style property should be serialized. (Inherited from C1.C1Preview.RenderObject) |
| ShouldSerializeTermDelimiter | Tests whether the TermDelimiter property should be serialized. |
| ShouldSerializeWidth | Tests whether the RenderObject.Width property should be serialized. (Inherited from C1.C1Preview.RenderObject) |
| ShouldSerializeX | Tests whether the RenderObject.X property should be serialized. (Inherited from C1.C1Preview.RenderObject) |
| ShouldSerializeY | Tests whether the RenderObject.Y property should be serialized. (Inherited from C1.C1Preview.RenderObject) |