Class ActionGoTo

Represents an action that changes the view to a destination (page, location, and magnification factor) specified by a DestinationBase object.

Hierarchy (View Summary)

ActionBase
- ActionGoTo

Index

Constructors

Accessors

Methods

Constructors

constructor

new ActionGoTo(
om: ObjectManager,
dest?: DestinationProperties | DestinationBase,
): ActionGoTo
Initialize a new instance of the ActionGoTo class.
Parameters
- om: ObjectManager
  ObjectManager that controls the lifetime of the ActionGoTo.
- Optionaldest: DestinationProperties | DestinationBase
  The destination object defining the new document view.
Returns ActionGoTo
Overrides ActionBase.constructor
new ActionGoTo(dest?: DestinationProperties | DestinationBase): ActionGoTo
Initialize a new instance of the ActionGoTo class.
Parameters
- Optionaldest: DestinationProperties | DestinationBase
  The destination object defining the new document view.
Returns ActionGoTo
Overrides ActionBase.constructor

Accessors

dest

get dest(): DestinationBase | null
Gets or sets the destination object defining the new document view.

Returns DestinationBase | null
set dest(value: DestinationProperties | DestinationBase | null): void
Gets or sets the destination object defining the new document view.
Parameters
- value: DestinationProperties | DestinationBase | null
Returns void

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from ActionBase.id

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ActionBase.om

Methods

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from ActionBase.free

rebind

rebind(omTo: ObjectManager): 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 ActionBase.rebind