Click or drag to resize

PdfLinkAnnotation Class

A link annotation represents either a hypertext link to a destination elsewhere in the document (see 12.3.2, "Destinations") or an action to be performed (12.6, "Actions").
Inheritance Hierarchy
SystemObject
  SautinSoft.PdfPdfObject
    SautinSoft.Pdf.AnnotationsPdfAnnotation
      SautinSoft.Pdf.AnnotationsPdfLinkAnnotation

Namespace: SautinSoft.Pdf.Annotations
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.11.26
Syntax
public sealed class PdfLinkAnnotation : PdfAnnotation

The PdfLinkAnnotation type exposes the following members.

Properties
 NameDescription
Public propertyActions(Optional; PDF 1.1) An action that shall be performed when the link annotation is activated (see 12.6, "Actions").
Public propertyAnnotationType Gets the Link value.
(Overrides PdfAnnotationAnnotationType)
Public propertyAppearance Gets the appearance settings for this PdfLinkAnnotation.
Public propertyDestination(Optional; not permitted if an A entry is present) The destination that shall be displayed when the annotation is activated (see 12.3.2, "Destinations").
Public propertyDestinationName(Optional; not permitted if an A entry is present) The named destination that shall be displayed when the annotation is activated (see 12.3.2.3, "Named Destinations").
Public propertyHighlightMode

(Optional; PDF 1.2) The annotation's highlighting mode, the visual effect that shall be used when the mouse button is pressed or held down inside its active area.

Default value: Invert.

Public propertyQuads

(Optional; PDF 1.6) An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space that comprise the region in which the link should be activated.

If this entry is not present or the conforming reader does not recognize it, the region specified by the Bounds entry should be used. Quads shall be ignored if any coordinate in the array lies outside the region specified by Bounds.

Top
Methods
 NameDescription
Public methodSetDestination

Sets the explicit destination that shall be displayed when the annotation is activated (see 12.3.2.2, "Explicit Destinations").

parameters represent the following values depending on the viewType parameter:

FitRectangle
Left, Bottom, Right and Top.
LeftTopZoom
Left, Top and Zoom.
FitPageVertical and FitContentVertical
Left.
FitPageHorizontal and FitContentHorizontal
Top.
FitPage and FitContent
None.
Top
Extension Methods
 NameDescription
Public Extension MethodGetArray Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetOrAddDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Top
See Also