RenderToc Class

Represents a table of contents (TOC) in a C1PrintDocument. Individual TOC entries are represented by RenderTocItem objects. This object may also contain other types of render objects (this may be used e.g. to show a TOC header).

Inheritance

object

RenderObject

RenderArea

RenderToc

Implements

IStyleOwner

IDocumentLocation

Namespace: C1.C1Preview

Assembly: C1.WPF.PrintDocument.4.6.2.dll

Syntax

public class RenderToc : RenderArea, IStyleOwner, IDocumentLocation

Public Class RenderToc
    Inherits RenderArea
    Implements IStyleOwner, IDocumentLocation

Constructors

Name	Description
RenderToc()	Initializes a new instance of the RenderToc class.

Properties

Name	Description
FillChar	Gets or sets a character used to fill empty spaces between TOC items and corresponding page numbers.
LevelSpacing	Gets or sets the indentation step of TOC items. Items with Level equal to 1 are not indented, each next level is indented by this value. The default value is 10mm.
LinksOnPageNumbersOnly	Gets or sets a value indicating whether only the page numbers in the rendered TOC represent clickable hyperlinks (otherwise, the entire area between an entry's caption and page number can be clicked). The default value is false.
PageNumbersAtRight	Gets or sets a value indicating whether page numbers should be right-aligned within the current TOC.
ShowPageNumbers	Gets or sets a value indicating whether page numbers should be displayed in the current TOC.

Methods

Name	Description
AddItem(string, C1Hyperlink)	Creates a new RenderTocItem initialized with the specified text and hyperlink, and adds it to the current TOC.
AddItem(string, C1Hyperlink, int)	Creates a new RenderTocItem initialized with the specified text, hyperlink and level, and adds it to the current TOC.
AddItem(string, ParagraphObject)	Creates a new RenderTocItem initialized with the specified text and target ParagraphObject, and adds it to the current TOC.
AddItem(string, ParagraphObject, int)	Creates a new RenderTocItem initialized with the specified text, target ParagraphObject and level, and adds it to the current TOC.
AddItem(string, RenderObject)	Creates a new RenderTocItem initialized with the specified text and target RenderObject, and adds it to the current TOC.
AddItem(string, RenderObject, int)	Creates a new RenderTocItem initialized with the specified text, target RenderObject and level, and adds it to the current TOC.
AddItem(string, int)	Creates a new RenderTocItem initialized with the specified text and target page number, and adds it to the current TOC.
AddItem(string, int, int)	Creates a new RenderTocItem initialized with the specified text, target page number and level, and adds it to the current TOC.
AssignFrom(RenderObject, bool, bool, bool, bool, bool, bool)	Assigns (copies) properties from another RenderObject to the current object. Calls the base AssignFrom(RenderObject, bool, bool, bool, bool, bool, bool) method. If `source` is a RenderToc, also copies RenderToc-specific properties.
CreateSame()	Creates new empty RenderArea object linked with same C1PrintDocument as current object.
ShouldSerializeLevelSpacing()	Indicates whether the LevelSpacing property should be serialized.