OutlineItem
extends PdfObject
in package
PDF Outline Item (bookmark entry).
Each item in the bookmarks tree. Items form a doubly-linked list at each level (Prev/Next) and a parent/child hierarchy (Parent/First/Last).
/Dest or /A must be set for the bookmark to navigate somewhere.
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V1_1
Table of Contents
Properties
- $a : PdfReference|null
- $c : PdfArray|null
- $count : int
- $dest : mixed
- /Dest - destination: PdfArray, PdfName (named dest), or string
- $f : int
- $first : PdfReference|null
- $generationNumber : int
- $last : PdfReference|null
- $next : PdfReference|null
- $objectNumber : int
- $parent : PdfReference|null
- $prev : PdfReference|null
- $title : PdfString
Methods
- __construct() : mixed
- toIndirectObject() : string
- Wrap the object in an indirect object structure: X Y obj ... endobj
- toPdf() : string
- Serialize the object's dictionary/value to PDF syntax.
Properties
$a
public
PdfReference|null
$a
= null
$c
public
PdfArray|null
$c
= null
/C - RGB color [r g b], values 0.0–1.0
$count
public
int
$count
= 0
$dest
/Dest - destination: PdfArray, PdfName (named dest), or string
public
mixed
$dest
= null
$f
public
int
$f
= 0
$first
public
PdfReference|null
$first
= null
$generationNumber
public
int
$generationNumber
= 0
$last
public
PdfReference|null
$last
= null
$next
public
PdfReference|null
$next
= null
$objectNumber
public
int
$objectNumber
= 0
$parent
public
PdfReference|null
$parent
= null
$prev
public
PdfReference|null
$prev
= null
$title
public
PdfString
$title
Methods
__construct()
public
__construct(string|PdfString $title) : mixed
Parameters
- $title : string|PdfString
toIndirectObject()
Wrap the object in an indirect object structure: X Y obj ... endobj
public
toIndirectObject() : string
Return values
stringtoPdf()
Serialize the object's dictionary/value to PDF syntax.
public
toPdf() : string