GetChapterObject

Description

Gets the object of a table of contents item.

Applies to

PDFTableOfContentsItem object

Syntax

PDFModel GetChapterObject()

Return value

PDFModel object. Depending on how you add the chapter into the table of contents (see the AddItem syntax), the returned object would be either PDFText object, or PDFTextblock object.

Usage

Call the function to get the object of a given table of contents item.

Examples

This example creates the table of contents item and then gets the object.

PDFtext lpdf_chapter_object
lpdf_toc =  create PDFtableofcontents
lpdf_title = create PDFtext
lpdf_chapter = create PDFtext

...
lpdf_chapter.content = "chapter1"

...
lpdf_tocitem = lpdf_toc.additem( lpdf_chapter)
lpdf_chapter_object = lpdf_tocitem.GetChapterObject()

See also

AddItem

GetChapterTitle

GetFont

GetItem

GetItemCount

RemoveAll

RemoveItem

SetFont