The requested page is not available for the requested platform. You are viewing the content for Default platform.

XRTableOfContents Class

A Table of Contents that is auto-generated based on the hierarchy of bookmarks contained in a report's document map.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

[XRDesigner("DevExpress.XtraReports.Design.XRTableOfContentsDesigner,DevExpress.XtraReports.v18.2.Extensions, Version=18.2.99.0, Culture=neutral, PublicKeyToken=c38a27d2243c2672")]
[ToolboxTabName("DX.18.2: Report Controls")]
[ToolboxBitmap(typeof(XRTableOfContents))]
[ToolboxBitmap24("DevExpress.XtraReports.Images.Toolbox24x24.XRTableOfContents.png,DevExpress.XtraReports.v18.2.Extensions, Version=18.2.99.0, Culture=neutral, PublicKeyToken=c38a27d2243c2672")]
[ToolboxBitmap32("DevExpress.XtraReports.Images.Toolbox32x32.XRTableOfContents.png,DevExpress.XtraReports.v18.2.Extensions, Version=18.2.99.0, Culture=neutral, PublicKeyToken=c38a27d2243c2672")]
[ToolboxSvgImage("DevExpress.XtraReports.SvgImages.Controls.XRTableOfContents.svg,DevExpress.XtraReports.v18.2.Extensions, Version=18.2.99.0, Culture=neutral, PublicKeyToken=c38a27d2243c2672")]
[XRToolboxSubcategory(3, 0)]
public class XRTableOfContents :
    XRFieldEmbeddableControl
<XRDesigner("DevExpress.XtraReports.Design.XRTableOfContentsDesigner,DevExpress.XtraReports.v18.2.Extensions, Version=18.2.99.0, Culture=neutral, PublicKeyToken=c38a27d2243c2672")>
<ToolboxTabName("DX.18.2: Report Controls")>
<ToolboxBitmap(GetType(XRTableOfContents))>
<ToolboxBitmap24("DevExpress.XtraReports.Images.Toolbox24x24.XRTableOfContents.png,DevExpress.XtraReports.v18.2.Extensions, Version=18.2.99.0, Culture=neutral, PublicKeyToken=c38a27d2243c2672")>
<ToolboxBitmap32("DevExpress.XtraReports.Images.Toolbox32x32.XRTableOfContents.png,DevExpress.XtraReports.v18.2.Extensions, Version=18.2.99.0, Culture=neutral, PublicKeyToken=c38a27d2243c2672")>
<ToolboxSvgImage("DevExpress.XtraReports.SvgImages.Controls.XRTableOfContents.svg,DevExpress.XtraReports.v18.2.Extensions, Version=18.2.99.0, Culture=neutral, PublicKeyToken=c38a27d2243c2672")>
<XRToolboxSubcategory(3, 0)>
Public Class XRTableOfContents
    Inherits XRFieldEmbeddableControl
    Implements

Remarks

A table of contents can only be displayed in a ReportHeaderBand. If this band is unavailable at the time the XRTableOfContents control is being dropped onto a report, it will be created automatically.

To learn more, see Adding a Table of Contents.

Implements

DevExpress.XtraReports.Serialization.IXRSerializable
DevExpress.Utils.Serializing.Helpers.IXtraSupportDeserializeCollectionItem
DevExpress.Utils.Serializing.IXtraSerializable
DevExpress.XtraReports.Native.IDisplayNamePropertyContainer
See Also