PdfGoToPageViewAction Class

Namespace:
GemBox.Pdf.Actions
Assembly:
GemBox.Pdf.dll

A go-to action changes the view to a specified destination (page, location, and magnification factor).

public sealed class PdfGoToPageViewAction : PdfAction
Public NotInheritable Class PdfGoToPageViewAction
    Inherits PdfAction
Inheritance:
System.Object
PdfGoToPageViewAction
Remarks

Specifying a go-to action in the A entry of a link annotation or outline item has the same effect as specifying the destination directly with the Dest entry.

Properties

ActionType

Gets the GoToPageView value.

public override PdfActionType ActionType { get; }
Public Overrides ReadOnly Property ActionType As PdfActionType
Property Value
PdfActionType

The GoToPageView value.

Overrides

Destination

(Required) The destination to jump to (see 12.3.2, "Destinations").

public PdfDestination Destination { get; set; }
Public Property Destination As PdfDestination
Property Value
PdfDestination

The destination to jump to.

Exceptions
System.ArgumentNullException

Value is null.

See Also

DestinationName

(Required) The named destination to jump to (see 12.3.2.3, "Named Destinations").

public string DestinationName { get; set; }
Public Property DestinationName As String
Property Value
System.String

The named destination to jump to.

Exceptions
System.ArgumentNullException

Value is null.

See Also

Methods

SetDestination(PdfPage, PdfDestinationViewType, Nullable<Double>[])

Sets the explicit destination to jump to (see 12.3.2.2, "Explicit Destinations").

parameters represent the following values depending on the viewType parameter:

public PdfDestination SetDestination(PdfPage page, PdfDestinationViewType viewType, params double? [] parameters)
Public Function SetDestination(page As PdfPage, viewType As PdfDestinationViewType, ParamArray parameters As Double?()) As PdfDestination
Parameters
page
PdfPage

The page to jump to.

viewType
PdfDestinationViewType

Type of the view.

parameters
System.Nullable<System.Double>[]

The parameters of the view.

Returns
PdfDestination

The explicit destination to jump to.

See Also

Inherited Properties

Metadata

(Optional; PDF 1.4) A metadata stream containing metadata for the component.

(Inherited from PdfObject)

Extension Methods

See Also