API Reference

Class

PdfLinkAnnotation

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Simple link annotation read from a PDF page.

Inheritance

  • Object
  • PdfLinkAnnotation

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Properties

public Nullable<Int32> PageNumber { get; } #

One-based page number when known; null when read directly from a page without document context.

public String Uri { get; } #

URI action target opened by the link annotation, or null for an internal named-destination link.

public String DestinationName { get; } #

Named destination opened by the link annotation, or null for a URI link.

public String NamedAction { get; } #

Named viewer action opened by the link annotation, for example NextPage, or null for other link target kinds.

public String RemoteFile { get; } #

External PDF file targeted by a remote GoTo action, or null for other link target kinds.

public String RemoteDestinationName { get; } #

Named destination in the external PDF targeted by a remote GoTo action, when present.

public Nullable<Int32> RemoteDestinationPageNumber { get; } #

One-based destination page number in the external PDF targeted by a simple remote GoTo destination array, when present.

public Nullable<Double> RemoteDestinationTop { get; } #

Top coordinate of the remote destination when present.

public Nullable<Double> RemoteDestinationLeft { get; } #

Left coordinate of the remote destination when present.

public Nullable<Double> RemoteDestinationBottom { get; } #

Bottom coordinate of the remote destination rectangle when present.

public Nullable<Double> RemoteDestinationRight { get; } #

Right coordinate of the remote destination rectangle when present.

public Nullable<PdfOpenActionDestinationMode> RemoteDestinationMode { get; } #

Viewer destination mode for the remote destination when present.

public Nullable<Int32> DestinationPageNumber { get; } #

One-based destination page number when the link targets a simple direct destination array.

public Nullable<Double> DestinationTop { get; } #

Top coordinate of the destination when present.

public Nullable<Double> DestinationLeft { get; } #

Left coordinate of the destination when present.

public Nullable<Double> DestinationBottom { get; } #

Bottom coordinate of the destination rectangle when present.

public Nullable<Double> DestinationRight { get; } #

Right coordinate of the destination rectangle when present.

public Nullable<PdfOpenActionDestinationMode> DestinationMode { get; } #

Viewer destination mode when the link uses a supported destination array.

public String Contents { get; } #

Optional annotation contents metadata.

public Double X1 { get; } #

Left edge of the annotation rectangle in PDF points.

public Double Y1 { get; } #

Bottom edge of the annotation rectangle in PDF points.

public Double X2 { get; } #

Right edge of the annotation rectangle in PDF points.

public Double Y2 { get; } #

Top edge of the annotation rectangle in PDF points.

public Double Width { get; } #

Rectangle width in PDF points.

public Double Height { get; } #

Rectangle height in PDF points.