[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Collapse]Controls and Libraries
   Reporting
  [Expand]Data Grid
  [Expand]Ribbon, Bars and Menu
  [Expand]Charts Suite
  [Expand]Pivot Grid
  [Expand]Scheduler
  [Expand]Spreadsheet
  [Collapse]Rich Text Editor
   [Expand]Product Information
    Product Class Structure
    Supported Formats
   [Expand]Getting Started
   [Expand]RichEditControl Document
   [Expand]Fields
    Text Formatting
    Import and Export
   [Collapse]Page Layout
     Line Numbering
     Table of Contents
     Layout API
     Measure Units
    Printing
    AutoCorrect
    Mail Merge
    Restrictions and Protection
    Syntax Highlighting
    Traversing the Document
   [Expand]Visual Elements
    Services
    Events
    Commands
    HTML Tag Support
   [Expand]Examples
  [Expand]Tree List
  [Expand]Gauge Controls
  [Expand]Map Control
  [Expand]Layout Management
  [Expand]Windows Modern UI
  [Expand]Printing-Exporting
  [Expand]Data Editors
  [Expand]Navigation Controls
  [Expand]Spell Checker
  [Expand]Property Grid
  [Expand]PDF Viewer
  [Expand]TreeMap Control
  [Expand]Diagram Control
  [Expand]Windows and Utility Controls
   Dialogs, Notifications and Panels
  [Expand]Scheduler (legacy)
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Table of Contents

This topic describes how to manually create a table of contents - from classic tables to tables of equations, and covers the following areas.

Expanded Create a Table of Contents

  1. Specify items that should be included into the TOC. To do that, mark paragraphs that correspond to the desired headings using one of the following approaches.
    • Outline levels

      Specify a paragraph outline level by the Paragraph.OutlineLevel property. With the outline level applied, the paragraph content formatting remains the same. The maximum outline level is 9.

    • Heading styles

      Create a new heading style or retrieve the existing one and apply it to the target paragraph using the ParagraphProperties.Style property. The collection of styles is accessible through the Document.ParagraphStyles property.

    • TC fields

      The use of the TC field allows you to show alternative titles in the table of contents. If your document needs two or more TOCs showing different entries, you can mark entries for a particular TOC using TC fields with an identifier (e.g., "{TC Finish \f bvz}”), which is specific for each TOC. To specify the outline level, use the \l field switch.

  2. Insert the TOC field with the corresponding switch and call the FieldCollection.Update method. Depending on the approach used to mark the TOC entry, the following switches can be used.

    • none - if entries are marked using heading styles
    • \u - if entries are marked by specifying the outline level
    • \f identifier - if the TC field is used
    Tip

    To insert all TOC entries as hyperlinks, use the \h switch. You can use any other TOC field switch to modify any kind of TOC to suit your needs.

Expanded Create a Table of Figures, Table of Tables, or Table of Equations

  1. To include an element into the table, insert the element caption using the SubDocument.AppendText method and mark it with the SEQ field.

    Show Me

    A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=T437901.

  2. Insert the TOC field with the \c switch and call the FieldCollection.Update method. The TOC will be created automatically.

    Show Me

    A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=T437901.

The table of figures will appear in the following way.

Expanded Table of Contents in the Command UI

End-users can create and update a table of contents, figures or captions using the corresponding commands of the References Ribbon tab. To see how to provide an application with the Ribbon Command UI, refer to the Lesson 5 - Create Separate Ribbon Pages for a Rich Text Editor article.

To include the heading into the TOC, end-users should do the following.

  • Select the target text.
  • On the References ribbon tab, in the Table of Contents group, click Add Text.
  • In the invoked list, select the required level.

As a result, the corresponding heading style (Heading 1, Heading 2, etc.) is automatically applied to the selected text and added to the list of available styles.

Note

The Table of Contents group allows end-users to operate the table of contents built from heading styles only. To create a TOC from outline levels or TC fields, end-users should insert the TOC field with the corresponding switch manually.

The Reference ribbon tab allows end-users to insert captions to the document tables, figures, or equations. To do that, in the Captions group, click Insert Captions and select the corresponding item.

The Table of Contents Dialog allows end-users to change the target table of contents' appearance by changing the number of displaying levels or by hiding the entries' page numbers.

Expanded See Also

Is this topic helpful?​​​​​​​