PDFVisualLinkAnnotation¶

Namespace: O2S.Components.PDF4NET.View.Annotations

Defines a link annotation that is displayed in a PDFDocumentView control.

public class PDFVisualLinkAnnotation : PDFVisualAnnotation

Inheritance Object → PDFVisualAnnotation → PDFVisualLinkAnnotation

Constructors¶

PDFVisualLinkAnnotation(PDFLinkAnnotation)¶

Initializes a new PDFVisualLinkAnnotation object.

public PDFVisualLinkAnnotation(PDFLinkAnnotation annotation)

Parameters

annotation PDFLinkAnnotation
The underlying PDF annotation.

Properties¶

Action¶

Gets or sets the link action.

public PDFAction Action { get; set; }

Property Value

PDFAction
An action to be performed when the link annotation is activated.

Remarks

PDFVisualLinkAnnotation.Destination and PDFVisualLinkAnnotation.Action are mutually exclusive, when one is set, the other is reset.

Annotation¶

Gets the underlying PDF annotation.

public PDFAnnotation Annotation { get; }

Property Value

PDFAnnotation
A PDF annotation.

Border¶

Gets or sets the annotation border.

public PDFAnnotationBorder Border { get; set; }

Property Value

PDFAnnotationBorder
A object specifying the style of the annotation border.

Destination¶

Gets or sets the link destination.

public PDFDestination Destination { get; set; }

Property Value

PDFDestination
A destination that specifies what page should be displayed when the link is clicked.

Remarks

PDFVisualLinkAnnotation.Destination and PDFVisualLinkAnnotation.Action are mutually exclusive, when one is set, the other is reset.

DisplayRectangle¶

Gets or sets the visual rectangle of this annotation.

public PDFDisplayRectangle DisplayRectangle { get; set; }

Property Value

PDFDisplayRectangle
A that represents the position and size of the annotation on the page.

Remarks

The visual rectangle is relative to the top left corner of the page.

HighlightStyle¶

Gets or sets the link highlighting style.

public PDFLinkAnnotationHighlightMode HighlightStyle { get; set; }

Property Value

PDFLinkAnnotationHighlightMode
A that specifies how the link is highlighted when it is activated.

NormalAppearance¶

Gets or sets the annotation normal appearance.

public PDFAnnotationAppearance NormalAppearance { get; set; }

Property Value

PDFAnnotationAppearance
A specifying how the annotation is presented visually on the page.

Tag¶

Gets or sets an object that contains user-defined data associated with the annotation.

public object Tag { get; set; }

Property Value

Object

Remarks

This property can be used to store any custom information relevant to the annotation at runtime. The value is not used by the annotation itself and is intended solely for application-specific data.
NOTE: The value of this property is not persisted in the PDF file.

VisualPage¶

Gets the page that owns the anotation.

public PDFVisualPage VisualPage { get; internal set; }

Property Value

PDFVisualPage
The PDFVisualPage that owns the annotation.