Class: DocumentDestinations

The dictionary of document destinations, provides an access to all destinations in the document:

Extends

• PdfStringMap<DocDestination>

Accessors

count

Get Signature

get count(): number;

Gets the number of items in the map.

Returns

number

Overrides

PdfStringMap.count

---

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

PdfStringMap.id

---

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

PdfStringMap.om

Methods

add()

add(key, item): void;

Adds the item with the specified key.

Parameters

key

string

The item key.

item

| DocDestination | DocDestinationProperties

The item to add.

Returns

void

Overrides

PdfStringMap.add

---

clear()

clear(): void;

Clears the collection.

Returns

void

Overrides

PdfStringMap.clear

---

contains()

contains(key): boolean;

Determines whether the specified key is in the collection.

Parameters

key

string

Returns

boolean

true if the key is in the collection, false otherwise.

Overrides

PdfStringMap.contains

---

free()

free(): void;

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

Returns

void

Inherited from

PdfStringMap.free

---

get()

get(key): DocDestination;

Gets the item with the specified key.

Parameters

key

string

Returns

DocDestination

Overrides

PdfStringMap.get

---

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

PdfStringMap.rebind

---

remove()

remove(key): boolean;

Removes the item with specified key from the collection.

Parameters

key

string

The key to remove.

Returns

boolean

true if the item with specified key was actually removed, false otherwise.

Overrides

PdfStringMap.remove

---

set()

set(key, item): void;

Sets the item with the specified key.

Parameters

key

string

The item key.

item

| DocDestination | DocDestinationProperties

The object to set.

Returns

void

Overrides

PdfStringMap.set