# Class: AnnotBorderStyle

## PDFNet. AnnotBorderStyle

#### new AnnotBorderStyle()

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

### Methods

#### <static> create(s, b_width, b_hr, b_vr)

  Constructor

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `s` | number/enum |
      PDFNet.AnnotBorderStyle.Style = {
      	e_solid : 0
      	e_dashed : 1
      	e_beveled : 2
      	e_inset : 3
      	e_underline : 4
      }
  `b_width` | number |
  `b_hr` | number |
  `b_vr` | number |

  ##### Returns:

  A promise that resolves to an object of type: "AnnotBorderStyle"

  Type
    PDFNet.AnnotBorderStyle

#### <static> createWithDashPattern(s, b_width, b_hr, b_vr, buffer)

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `s` | number/enum |
      PDFNet.AnnotBorderStyle.Style = {
      	e_solid : 0
      	e_dashed : 1
      	e_beveled : 2
      	e_inset : 3
      	e_underline : 4
      }
  `b_width` | number |
  `b_hr` | number |
  `b_vr` | number |
  `buffer` | Array |

  ##### Returns:

  A promise that resolves to an object of type: "AnnotBorderStyle"

  Type
    PDFNet.AnnotBorderStyle

#### assign(to)

  Copy Constructor

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `to` | PDFNet.AnnotBorderStyle |

#### copy()

  Copy Constructor

  ##### Returns:

  A promise that resolves to an object of type: "AnnotBorderStyle"

  Type
    PDFNet.AnnotBorderStyle

#### destroy()

  Frees the native memory of the object.

#### getDashPattern()

  See:
    - BorderStyle()

  ##### Returns:

  the border dash pattern.

#### getHR()

  ##### Returns:

  A promise that resolves to horizontal corner radius.

  Type
    number

#### getStyle()

  ##### Returns:

  A promise that resolves to the border style.

  Type
    number

  ##### Example

      Return value enum:
      <pre>
      PDFNet.AnnotBorderStyle.Style = {
      	e_solid : 0
      	e_dashed : 1
      	e_beveled : 2
      	e_inset : 3
      	e_underline : 4
      }
      </pre>

#### getVR()

  ##### Returns:

  A promise that resolves to vertical corner radius.

  Type
    number

#### getWidth()

  ##### Returns:

  A promise that resolves to the border width.

  Type
    number

#### setHR(horizontal_radius)

  Sets horizontal corner radius.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `horizontal_radius` | number | A number representing the value of the horizontal radius to set the annotation to.

#### setStyle(style)

  Sets the border style.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `style` | number/enum |
      PDFNet.AnnotBorderStyle.Style = {
      	e_solid : 0
      	e_dashed : 1
      	e_beveled : 2
      	e_inset : 3
      	e_underline : 4
      }

#### setVR(vertical_radius)

  Sets vertical corner radius.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `vertical_radius` | number | A number representing the value of the vertical radius to set the annotation to.

#### setWidth(width)

  Sets the border width

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `width` | number | A number representing the width value to set the annotation to.

#### Search results