PdfAnnotationBorder Class

The border of an annotation (ISO 32000-2, 12.5.4): its border style dictionary (/BS), the older border array (/Border) when the annotation has no style dictionary, and its border effect (/BE).

public sealed class PdfAnnotationBorder

Remarks

The setters write the border style dictionary; the viewers prefer it to the border array. Changing the border does not change an appearance stream the annotation already has: call PdfAnnotation.UpdateAppearance.

Properties

NameDescription
BorderStyleGets or sets the style of the border (/BS /S). The default is PdfAnnotationBorderStyle.Solid; a border array with dashes is PdfAnnotationBorderStyle.Dashed.
CloudyIntensityGets or sets the intensity of the cloudy effect of the border (/BE, 12.5.4, table 169), from 0 to 2: the border of a square, a circle, a polygon or a free text is drawn as a series of arcs. 0, the default, is a plain border.
DashPatternGets or sets the lengths of the dashes and of the gaps of a dashed border (/BS /D, or the fourth element of /Border), in points. The default is a dash of 3 points and a gap of 3 points; an empty list removes the entry.
WidthGets or sets the width of the border, in points (/BS /W, or the third number of /Border); 0 for no border. The default is 1.

Gets or sets the style of the border (/BS /S). The default is PdfAnnotationBorderStyle.Solid; a border array with dashes is PdfAnnotationBorderStyle.Dashed.

public PdfAnnotationBorderStyle BorderStyle { get; set; }

CloudyIntensity

PdfAnnotationBorder.cs

Gets or sets the intensity of the cloudy effect of the border (/BE, 12.5.4, table 169), from 0 to 2: the border of a square, a circle, a polygon or a free text is drawn as a series of arcs. 0, the default, is a plain border.

public double CloudyIntensity { get; set; }

Property value

double

Exceptions

ArgumentOutOfRangeException
The value is not between 0 and 2.

Gets or sets the lengths of the dashes and of the gaps of a dashed border (/BS /D, or the fourth element of /Border), in points. The default is a dash of 3 points and a gap of 3 points; an empty list removes the entry.

public IReadOnlyList<double> DashPattern { get; set; }

Property value

IReadOnlyList<double>

Exceptions

ArgumentException
A length is negative or not finite, or all the lengths are 0.

Gets or sets the width of the border, in points (/BS /W, or the third number of /Border); 0 for no border. The default is 1.

public double Width { get; set; }

Property value

double

Exceptions

ArgumentOutOfRangeException
The value is negative or not finite.