Skip to main content

XRTableOfContents Members

A control that generates a table of contents in a report composed of sections and their corresponding page numbers based on the hierarchy of bookmarks contained in the report document map.

Constructors

Name Description
XRTableOfContents() Initializes a new instance of the XRTableOfContents class with the default settings.

Properties

Name Description
BackColor Gets or sets a control’s background color. Inherited from XRControl.
Band Provides access to the owner band, in which the current control is situated. Inherited from XRControl.
BorderColor Gets or sets the control’s border color. Inherited from XRControl.
BorderDashStyle Specifies the dash style for the control’s border. Inherited from XRControl.
Borders Specifies a set of borders (top, right, bottom, left) that should be visible for the control. Inherited from XRControl.
BorderWidth Specifies the width of cell borders in pixels, as a floating point value. Inherited from XRControl.
BottomF Gets the Y-coordinate of the control’s bottom edge (measured in report units). Inherited from XRControl.
BoundsF For internal use only. Overrides the XRControl.BoundsF property, to hide it.
CanGrow Gets or sets a value indicating whether the control’s height can grow in order to display the content in its entirety. Inherited from XRControl.
CanHaveChildren For internal use only. Overrides the XRControl.CanHaveChildren property, to hide it.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
CanShrink Gets or sets a value that determines whether the height of a control can decrease if its content does not completely fill the control. Inherited from XRControl.
Container Gets the IContainer that contains the Component. Inherited from Component.
Controls Gets the collection of XRControl objects or their descendants that are contained in this control. Inherited from XRControl.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
EvenStyleName Gets or sets the style applied to the control when it displays an even record from the bound data source. Inherited from XRControl.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
ExpressionBindings Provides access to a control’s collection of expression bindings. Inherited from XRControl.
ForeColor Gets or sets the control’s foreground color. Inherited from XRControl.
HasChildren Gets a value indicating whether the control contains other XRControl objects. Inherited from XRControl.
HeightF Specifies the control’s height (measured in report units). Inherited from XRControl.
Index Gets the zero-based index of this control in its parent’s collection of controls. Inherited from XRControl.
IsDisposed For internal use. Gets a value indicating whether the control has been disposed of. Inherited from XRControl.
IsSingleChild Checks whether the report element (control or band) is a single child of its parent. Inherited from XRControl.
LeftF Specifies the X-coordinate of the control’s left edge (measured in report units). Inherited from XRControl.
LevelDefault Contains default formating properties for hierarchical levels of XRTableOfContents.
Levels Provides access to the collection of XRTableOfContents levels.
LevelTitle Contains text and formating properties for a title of an XRTableOfContents.
LocationF Specifies the floating-point representation of the coordinates of the control’s upper-left corner. Inherited from XRControl.
LocationFloat For internal use. Supports serialization of the XRControl.LocationF property. Inherited from XRControl.
LockedInUserDesigner Gets or sets a value that specifies whether this control can be changed by an end-user in the End-User Designer. Inherited from XRControl.
MaxNestingLevel Specifies the maximum number of XRTableOfContents levels to be displayed. If set to 0, no limitation applied.
Name Gets or sets a name of the control. Inherited from XRControl.
OddStyleName Gets or sets the style applied to the control when it displays an odd record from the bound data source. Inherited from XRControl.
Padding Gets or sets the control’s padding values (measured in report units). Inherited from XRControl.
Parent Specifies the parent object that contains the current control. Inherited from XRControl.
Report Provides access to the report that contains the control. Inherited from XRControl.
RightF Gets the X-coordinate of the control’s right edge (measured in report units). Inherited from XRControl.
RightToLeft Specifies the orientation of the XRTableOfContents‘s content.
RootReport Provides access to the report to which the control belongs. Inherited from XRControl.
Site Gets or sets the ISite of the Component. Inherited from Component.
StyleName Gets or sets the name of the style, which is applied to the current control. Inherited from XRControl.
StylePriority Allows you to specify properties whose values for an individual control have priority over the same properties specified for the style assigned to the control. Inherited from XRControl.
Styles Overrides the XRControl.Styles property to hide it.
Tag Bindable. Gets or sets the object that contains data about this control. Inherited from XRControl.
TopF Gets or sets the Y-coordinate of the control’s top edge (measured in report units). Inherited from XRControl.
Visible Gets or sets a value that specifies whether the report control is displayed in the document. Inherited from XRControl.
WidthF Specifies the control’s width (measured in report units). Inherited from XRControl.

Methods

Name Description
AllControls<T>() Returns a collection that contains all controls found within XRControl (within a report). Inherited from XRControl.
AllLevels() For internal use.
BringToFront() Brings the control to the front of the z-order. Inherited from XRControl.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose() Releases all resources used by the Component. Inherited from Component.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
FindControl(String, Boolean) Finds the control that has the specified name in the XRControl.Controls collection. Inherited from XRControl.
GetEffectiveBackColor() Returns the color actually used as the control’s background color. Inherited from XRControl.
GetEffectiveBorderColor() Returns the color actually used as the control’s border color. Inherited from XRControl.
GetEffectiveBorderDashStyle() Returns the border dash style that is actually used by the control. Inherited from XRControl.
GetEffectiveBorders() Returns the borders settings actually used as the control’s borders settings. Inherited from XRControl.
GetEffectiveBorderWidth() Returns the border width settings actually used as the control’s current settings. Inherited from XRControl.
GetEffectiveFont() Returns the font actually used as the control’s font. Inherited from XRControl.
GetEffectiveForeColor() Returns the color actually used as the control’s foreground color. Inherited from XRControl.
GetEffectivePadding() Returns the padding values actually used as the control’s padding. Inherited from XRControl.
GetEffectiveStyle() Returns the actual visual style of a control taking into account all formatting rules and odd/even styles applied to the control. Inherited from XRControl.
GetEffectiveTextAlignment() Returns the text alignment actually used as the control’s text alignment. Inherited from XRControl.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType() Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
PerformLayout() Forces the control to apply layout logic to itself and all its child controls. Inherited from XRControl.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemoveInvalidBindings(Predicate<XRBinding>) Removes inappropriate bindings assigned to the XRControl‘s properties. Inherited from XRControl.
ResetBackColor() Resets the XRControl.BackColor property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetBorderColor() Resets the XRControl.BorderColor property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetBorderDashStyle() Resets the XRControl.BorderDashStyle property to en empty value. Inherited from XRControl.
ResetBorders() Resets the XRControl.Borders property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetBorderWidth() Resets the XRControl.BorderWidth property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetFont() Resets the XRControl.Font property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetForeColor() Resets the XRControl.ForeColor property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetPadding() Resets the XRControl.Padding property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetTextAlignment() Resets the XRControl.TextAlignment property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResumeLayout() Resumes normal layout logic for the control. Inherited from XRControl.
SendToBack() Sends the control to the back of the z-order. Inherited from XRControl.
SuspendLayout() Temporarily suspends the layout logic for the control. Inherited from XRControl.
ToImage() Returns a graphical representation of a control. Inherited from XRControl.
ToImage(DXTextRenderingHint) Returns the graphical representation of a control created using the specified text rendering mode. Inherited from XRControl.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

Name Description
AfterPrint Occurs after an XRControl object is displayed in the report. Inherited from XRControl.
BeforePrint Occurs before an XRControl object creates its image in a report being generated. Inherited from XRControl.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
LocationChanged Occurs when the value of the XRControl.LocationF property is changed. Inherited from XRControl.
ParentChanged Occurs when the XRControl instance’s parent is changed. Inherited from XRControl.
SizeChanged Occurs when the value of the XRControl.SizeF property is changed. Inherited from XRControl.
See Also