DestinationRef

Class: DestinationRef

Defines destination as reference to another destination, referenced destination can be in Dests dictionary of PDF document or in Dests subtree of Name Tree.

Extends

DestinationBase

Constructors

Constructor

new DestinationRef(
   om, 
   name, 
   nameTree?): DestinationRef;

Initializes a new instance of the DestinationRef class.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the DestinationRef.

name

string

The name of referenced destination.

nameTree?

boolean

Specifies where referenced destination is in Dests dictionary of document or in Dests subtree of Name Tree.

Returns

DestinationRef

Overrides

DestinationBase.constructor

Constructor

new DestinationRef(name, nameTree?): DestinationRef;

Initializes a new instance of the DestinationRef class.

Parameters

name

string

The name of referenced destination.

nameTree?

boolean

Specifies where referenced destination is in Dests dictionary of document or in Dests subtree of Name Tree.

Returns

DestinationRef

Overrides

DestinationBase.constructor

Accessors

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

DestinationBase.id

name

Get Signature

get name(): string;

Gets the name of referenced destination in the Dests dictionary of PDF document.

Returns

string

nameTree

Get Signature

get nameTree(): boolean;

Gets a value indicating whether this DestinationRef references destination in Dests dictionary of PDF document or in Dests subtree of document's Name Tree.