class HexaPDF::Type::Names

Parent	HexaPDF::Dictionary

Represents the PDF’s names dictionary which associates names with data for various purposes.

Each field corresponds to a name tree that holds the information and can be used to find, add or delete an entry.

This dictionary is linked via the /Names entry from the HexaPDF::Catalog.

See: PDF2.0 s7.7.4, HexaPDF::Catalog, HexaPDF::NameTreeNode

Field Definitions

Name	Type/Allowed Values	Required	Default Value
Dests	HexaPDF::NameTreeNode or Hash	false	nil
AP	HexaPDF::NameTreeNode or Hash	false	nil
JavaScript	HexaPDF::NameTreeNode or Hash	false	nil
Pages	HexaPDF::NameTreeNode or Hash	false	nil
Templates	HexaPDF::NameTreeNode or Hash	false	nil
IDS	HexaPDF::NameTreeNode or Hash	false	nil
URLS	HexaPDF::NameTreeNode or Hash	false	nil
EmbeddedFiles	HexaPDF::NameTreeNode or Hash	false	nil
AlternatePresentations	HexaPDF::NameTreeNode or Hash	false	nil
Renditions	HexaPDF::NameTreeNode or Hash	false	nil

Public Instance Methods

destinations()¶

Returns the destinations name tree containing a mapping from names to destination objects.

The name tree will be created if needed.

Note: It is possible to use this name tree directly, but HexaPDF::Document::Destinations provides a much easier to work with convenience interface for working with destination objects.

See: PDF2.0 s12.3.2