Class PdfDestination

Namespace

nebulae.dotPDFium

Assembly

dotPDFium.dll

Represents a destination within a PDF document, typically used for navigation or linking purposes.

public sealed class PdfDestination

Inheritance

object

PdfDestination

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A destination specifies a particular location within a PDF document, such as a specific page and optionally a position on that page. This class provides access to the page index and location information for the destination.

Properties

PageIndex

Gets the zero-based index of the page associated with the destination.

public int PageIndex { get; }

Property Value

int

Methods

GetDirectDestinationPage()

Retrieves the zero-based index of the destination page directly associated with this object.

public int? GetDirectDestinationPage()

Returns

int?

The zero-based index of the destination page if one is associated; otherwise, null.

Remarks

This method returns null if no valid destination page is associated with the object.

GetLocation()

Retrieves the location of the destination within the page.

public FsPointF? GetLocation()

Returns

FsPointF?

A FsPointF representing the location of the destination within the page, or null if the location cannot be determined. Coordinates will be zero if not explicitly defined.

GetView()

Retrieves the view mode and parameters associated with the destination.

public (PdfDestViewMode ViewMode, float[] Parameters)? GetView()

Returns

(PdfDestViewMode ViewMode, float[] Parameters)?

A tuple containing the PdfDestViewMode and associated parameters, or null if the view information is not available.

GetZoom()

Retrieves the zoom level of the destination, if explicitly defined.

public float? GetZoom()

Returns

float?

The zoom factor if defined, otherwise null.

TryGetDirectDestinationPage(out int)

Attempts to retrieve the destination page index associated with the current destination object.

public bool TryGetDirectDestinationPage(out int pageIndex)

Parameters

pageIndex int

When this method returns, contains the zero-based index of the destination page if the operation succeeds; otherwise, contains a negative value.

Returns

bool

true if the destination page index was successfully retrieved; otherwise, false.