PDFTOCEntry

From Xojo Documentation

You are currently browsing the old Xojo documentation site. Please visit the new Xojo documentation site!

Class (inherits from Object)


New in 2021r3

Used to create a TOC (Table Of Contents) index in the PDF Document.

Properties
PageNumber X
Title Y
Methods
AddEntry
Constructors

Constructor(page As Integer, title As String, x As Integer, y As Integer)


Notes

Add a table of contents entry to PDF document using the PDFDocument.AddTOCEntry method.

Sample Code

This examples creates a table of contents (mainTOC) and an introduction entry (introTOC), adds the introTOC as a subentry to the mainTOC then adds the mainTOC to the PDFDocument, pdfDOC:

Var mainTOC As New PDFTOCEntry(1, "Chapter 1", 0, 0)
Var introTOC As New PDFTOCEntry(2, "Introduction", 0, 0)
mainTOC.AddEntry(introTOC)
pdfDOC.AddTOCEntry(mainTOC)

Compatibility

All project types on all supported operating systems. Desktop projects on Linux, macOS and Windows.

See Also

PDFDocument class.