Skip to content

# PDFVisualInkAnnotation

Namespace: O2S.Components.PDF4NET.View.Annotations

Defines an ink annotation that is displayed in a control.

    public class PDFVisualInkAnnotation : PDFVisualMarkupAnnotation

Inheritance Object → PDFVisualAnnotation → PDFVisualMarkupAnnotation → PDFVisualInkAnnotation

## Constructors

### PDFVisualInkAnnotation(PDFInkAnnotation)

Initializes a new PDFVisualAnnotation object.

    public PDFVisualInkAnnotation(PDFInkAnnotation annotation)

Parameters

`annotation` PDFInkAnnotation
The underlying PDF annotation.

## Properties

### Annotation

Gets the underlying PDF annotation.

    public PDFAnnotation Annotation { get; }

Property Value

PDFAnnotation
A PDF annotation.

### 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.

### Ink

Gets or sets the annotation ink.

    public PDFAnnotationBorder Ink { get; set; }

Property Value

PDFAnnotationBorder
A object specifying the style of the annotation ink.

### 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.

### Opacity

Gets or sets the annotation opacity.

    public double Opacity { get; set; }

Property Value

Double
A value in the range [0, 1] that represents the constant opacity value to be used in painting the annotation.

### Points

Gets or sets the annotation points.

    public PDFPoint[][] Points { get; set; }

Property Value

PDFPoint[][]
An array of arrays, each array defining a path.

Exceptions

ArgumentException
Thrown when this property is set and the annotation does not belong to a page.

Remarks

The points in this array are given in page visual coordinates, relative to top left corner of the visual 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.

## Methods

### EndUpdate()

Notifies the control that the annotation has been updated and its new appearance should be displayed.

    public void EndUpdate()

Remarks

PDFVisualAnnotation.BeginUpdate() must be called first before calling this method.