PDFVisualLineAnnotation¶

Namespace: O2S.Components.PDF4NET.View.Annotations

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

public class PDFVisualLineAnnotation : PDFVisualMarkupAnnotation

Inheritance Object → PDFVisualAnnotation → PDFVisualMarkupAnnotation → PDFVisualLineAnnotation

Constructors¶

PDFVisualLineAnnotation(PDFLineAnnotation)¶

Initializes a new PDFVisualLineAnnotation object.

public PDFVisualLineAnnotation(PDFLineAnnotation annotation)

Parameters

annotation PDFLineAnnotation
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.

EndLineSymbol¶

Gets or sets the symbol used for the end of the line.

public PDFLineEndingStyle EndLineSymbol { get; set; }

Property Value

PDFLineEndingStyle
A that represents the end of the line.

EndPoint¶

Gets or sets the end point.

public PDFPoint EndPoint { get; set; }

Property Value

PDFPoint
The line end point, in visual coordinates.

Remarks

Because the end point uses page visual coordinates, the annotation must be added to the page before setting the end point.

InteriorColor¶

Gets or sets the annotation interior color.

public PDFColor InteriorColor { get; set; }

Property Value

PDFColor
A specifying the interior color with which to fill the annotation's interior.

Exceptions

ArgumentOutOfRangeException
Thrown when the property is set to a color other than Gray, RGB or CMYK.

Line¶

Gets or sets the annotation line style.

public PDFAnnotationBorder Line { get; set; }

Property Value

PDFAnnotationBorder
A object specifying the style of the annotation line style.

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.

StartLineSymbol¶

Gets or sets the symbol used for the start of the line.

public PDFLineEndingStyle StartLineSymbol { get; set; }

Property Value

PDFLineEndingStyle
A that represents the start of the line.

StartPoint¶

Gets or sets the start point.

public PDFPoint StartPoint { get; set; }

Property Value

PDFPoint
The line start point, in visual coordinates.

Remarks

Because the start point uses page visual coordinates, the annotation must be added to the page before setting the start point.

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.