| FoxitPDFSDKforWeb v11.0.5 Archives Foxit PDF SDK for Web

Public Member Functions | List of all members
GoToAction Class Reference
PDF » actions

GoTo action object. More...

Inheritance diagram for GoToAction:

## Public Member Functions
| getDestination ()
| Get the destination information. More...
| setDestination (destination)
| Set the destination information. More...
Public Member Functions inherited from Action
| getSubAction (index)
| Get a sub-action by index. More...
| getSubActionCount ()
| Get the count of sub-actions. More...
| getType ()
| Get action type. More...
| insertSubAction (index, action)
| Insert a new sub-action to the location specified by index. More...
| removeAllSubActions ()
| Remove all the sub-actions. More...
| removeSubAction (index)
| Remove a sub-action, specified by index. More...
| setSubAction (index, action)
| Set a sub-action by index. More...

## Detailed Description

GoTo action object.

Deprecated:
  Action related APIs have been moved under each object.

See also
  Annot
  Widget
  PDFFormField
  PDFDoc

## Member Function Documentation

## ◆ getDestination()

GoToAction::getDestination | ( |  | ) |
| inline

Get the destination information.

Returns
  object - A destination object.

## ◆ setDestination()

GoToAction::setDestination | ( |  | destination | ) |
| inline

Set the destination information.

Parameters

  destination | object - A valid destination object to be set.
  destination.zoomMode | string - Set the zoom mode.Please refer to values starting from ZoomMode and this would be one of these values.
  destination.zoomFactor | number - Set zoom factor.This is only useful when zoom mode is ZoomXYZ. For ZoomXYZ, if the zoom factor is 0, that means just use current zoom factor of application as the destination zoom factor. For other zoom mode, this function will be 0. Valid when the zoomMode is ZoomXYZ.
  destination.pageIndex | string - The index of the destination page in the PDF document.
  destination.left | string - Set left position value. Valid when the zoomMode is ZoomXYZ or ZoomFitRect.
  destination.top | string - Set top position value. Valid when the zoomMode is ZoomXYZ or ZoomFitRect or ZoomFitHorz.
  destination.right | string - Set right position value. Valid when the zoomMode is ZoomFitRect.
  destination.bottom | string - Set bottom position value. Valid when the zoomMode is ZoomFitRect.

Returns
  Promise<object> - An action object.

@2025 Foxit Software Incorporated. All rights reserved.