Table of Contents

23.12.2 Class PdfIndex (gb.poppler)

This class represents a single entry in the table of contents in a PDF document - if this directory exists.

How to determine the number of entries in the table of contents: 

If hPdfDocument.Index.Count > 0 Then
   Print "Anzahl der Einträge im Inhaltsverzeichnis = "; hPdfDocument.Index.Count
Endif

23.12.2.1 Properties

The PdfIndex class has the following properties:

PropertyData typeDescription
ActionPdfActionReturns the action associated with this index entry.
ChildrenIntegerReturns the number of sub-indexes for this index entry.
OpenedBooleanReturns with True whether the index entry is open - whether its child entries are visible.
ParentIntegerReturns the index of a parent element in the index hierarchy. The index of a root element is -1.
TextStringReturns the text associated with this index entry.

Table 23.12.2.1.1 : Properties of the PdfIndex class

Notes

Opened: The Poppler documentation states: “Returns to the user whether this node should be expanded by default. The document may provide an indication of how the document's index should initially be expanded. “Text: Note that the text is output as it is found in a particular rectangle - as shown in the snippet in the following example: 

Die Experimente zur Bestimmung des Stehwellen-Verhältnisses (SWR) wurden auf einem
kommerziellen Messplatz an der Kaiser-Max-Universität in Heidelburg durchgeführt. Die
Antennenhöhe betrug 11,3 m. Die Leistung wurde auf 10 W Ausgangsleistung begrenzt.
Folgende Antennen für den Amateur-Funk wurden untersucht:
* Richtantenne FB33 (3-Element-Beam für das 20m-Band, 15m-Band und das 10m-Band)
* 2-Element-Monoband-Yagi für das 20m-Band
* 2-Element-Monoband-Loop für das 20m-Band
Auswertung:
Bei allen drei Amateurfunk-Antennen konnten die in den Datenblättern angegebenen
Werte hinreichend bestätigt werden. Das bezieht sich jedoch nur auf die Größe des SWR.
Abweichungen gab es bei der Lage der Minima im Frequenz-Band.

This is the (formatted, original) continuous text snippet:

Text

Illustration: Continuous text excerpt

23.12.2.2 PdfAction class

The PdfAction class has the following five properties:

PropertyData typeDescription
Goto.PdfActionGotoReturns a virtual object that describes what the action triggers for actions that target a different location in the PDF document.
Launch.PdfActionLaunchReturns a virtual object that describes what the action triggers for actions that start another programme.
TextStringReturns the action text. Example: 'GotoDest'
TypeStringReturns the action type as a character string. Example: '25.1.12.3 Project 3'
URI.PdfActionURIReturns a virtual object that describes what the action triggers for actions that target an external URI.

Table 23.12.2.2.1 : Properties of the PdfAction class

23.12.2.2.1 Virtual class PdfActionGoto

The virtual class PdfActionGoto has the following four properties:

PropertyData typeDescription
PageIntegerReturns the target page of the action.
RectRectFReturns the target rectangle of the action; relative to the target page.
TargetStringReturns the argument of the action.
ZoomFloatReturns the target zoom of the action.

Table 23.12.2.2.2 : Properties of the PdfActionGoto class

23.12.2.2.2 Virtual class PdfActionLaunch

The virtual class PdfActionLaunch has the following two properties:

PropertyData typeDescription
ArgumentsStringReturns the arguments of the programme to be started.
TargetStringReturns the file name of the programme to be started.

Table 23.12.2.2.3 : Properties of the PdfActionLaunch class

23.12.2.2.3 Virtual class .PdfActionURI

The virtual class PdfActionURI only has this property:

PropertyData typeDescription
TargetStringReturns the target URI.

Table 23.12.2.2.4 : Properties of the PdfActionURI class