PDFAnnotationBorder¶

Namespace: O2S.Components.PDF4NET.Annotations

Defines the border for various annotations.

public class PDFAnnotationBorder

Inheritance Object → PDFAnnotationBorder

Constructors¶

PDFAnnotationBorder()¶

Initializes a new PDFAnnotationBorder object.

public PDFAnnotationBorder()

Properties¶

Color¶

Gets or sets the border color.

public PDFColor Color { get; set; }

Property Value

PDFColor
A PDFColor specifying the border color with which to stroke the annotation's border.

Exceptions

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

DashPattern¶

Gets or sets the array that represents the dash pattern when the PDFAnnotationBorder.Style property is set to PDFAnnotationBorderStyle.Dashed.

public Double[] DashPattern { get; set; }

Property Value

Double[]

Style¶

Gets or sets the annotation border style.

public PDFAnnotationBorderStyle Style { get; set; }

Property Value

PDFAnnotationBorderStyle
A PDFAnnotationBorderStyle enum specifying the style of the annotation border.

Width¶

Gets or sets the border width.

public double Width { get; set; }

Property Value

Double
The width of the square outline drawn in the annotation.

Exceptions

ArgumentOutOfRangeException
Thrown when this property is set to a negative value.