[]
        
(Showing Draft Content)

DestinationRef

DsPdfJS API v9.1.0


DsPdfJS API / 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

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 | null

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

Returns

boolean | null


om

Get Signature

get om(): ObjectManager

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

DestinationBase.om

Methods

free()

free(): void

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

DestinationBase.free


rebind()

rebind(omTo): void

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

DestinationBase.rebind