Class Annot.BorderStyle

BorderStyle structure specifies the characteristics of the annotation's border. The border is specified as a rounded rectangle.

Inheritance

object

Annot.BorderStyle

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: pdftron.PDF

Assembly: PDFNet.dll

Syntax

public class Annot.BorderStyle

Constructors

BorderStyle(Style, double)

Creates a new border style with given parameters.

Declaration

public BorderStyle(Annot.BorderStyle.Style s, double b_width)

Parameters

Type	Name	Description
Annot.BorderStyle.Style	s	The border style.
double	b_width	The border width expressed in the default user space.

BorderStyle(Style, double, double, double)

Creates a new border style with given parameters.

Declaration

public BorderStyle(Annot.BorderStyle.Style s, double b_width, double b_hr, double b_vr)

Parameters

Type	Name	Description
Annot.BorderStyle.Style	s	The border style.
double	b_width	The border width expressed in the default user space.
double	b_hr	The horizontal corner radius expressed in the default user space.
double	b_vr	The vertical corner radius expressed in the default user space. in drawing the border. The dash array is specified in the same format as in the line dash pattern parameter of the graphics state except that the phase is assumed to be 0.

Remarks

If the corner radii are 0, the border has square (not rounded) corners; if the border width is 0, no border is drawn.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

BorderStyle(Style, double, double, double, double[])

Creates a new border style with given parameters.

Declaration

public BorderStyle(Annot.BorderStyle.Style s, double b_width, double b_hr, double b_vr, double[] dash_array)

Parameters

Type	Name	Description
Annot.BorderStyle.Style	s	The border style.
double	b_width	The border width expressed in the default user space.
double	b_hr	The horizontal corner radius expressed in the default user space.
double	b_vr	The vertical corner radius expressed in the default user space.
double[]	dash_array	An array of numbers defining a pattern of dashes and gaps to be used in drawing the border. The dash array is specified in the same format as in the line dash pattern parameter of the graphics state except that the phase is assumed to be 0.

Remarks

If the corner radii are 0, the border has square (not rounded) corners; if the border width is 0, no border is drawn.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

Properties

border_style

the border style

Declaration

public Annot.BorderStyle.Style border_style { get; set; }

Property Value

Type	Description
Annot.BorderStyle.Style

dash

the border dash pattern

Declaration

public double[] dash { get; set; }

Property Value

Type	Description
double[]

hr

horizontal corner radius

Declaration

public double hr { get; set; }

Property Value

Type	Description
double

vr

vertical corner radius

Declaration

public double vr { get; set; }

Property Value

Type	Description
double

width

the border width

Declaration

public double width { get; set; }

Property Value

Type	Description
double