# Border

## Content

[**DsPdfJS API v9.1.3**](../README)

***

[DsPdfJS API](../globals) / Border

# Class: Border

Defines properties of the annotation's border.

## Extends

- [`ObjectBase`](ObjectBase)

## Constructors

### Constructor

> **new Border**(`om?`): `Border`

Creates a new Border.

#### Parameters

##### om?

[`ObjectManager`](ObjectManager)

[ObjectManager](ObjectManager) that controls the lifetime of the Border.

#### Returns

`Border`

#### Overrides

`ObjectBase.constructor`

### Constructor

> **new Border**(): `Border`

Creates a new Border.

#### Returns

`Border`

#### Overrides

`ObjectBase.constructor`

## Accessors

### color

#### Get Signature

> **get** **color**(): [`Color`](../type-aliases/Color)

Gets or sets the border color.

##### Returns

[`Color`](../type-aliases/Color)

#### Set Signature

> **set** **color**(`value`): `void`

Gets or sets the border color.

##### Parameters

###### value

[`Color`](../type-aliases/Color)

##### Returns

`void`

***

### dashPattern

#### Get Signature

> **get** **dashPattern**(): `number`[] \| `null`

Gets or sets the dash pattern, used if 'style' == 'BorderStyle.Dashed'.

##### Returns

`number`[] \| `null`

#### Set Signature

> **set** **dashPattern**(`value`): `void`

Gets or sets the dash pattern, used if 'style' == 'BorderStyle.Dashed'.

##### Parameters

###### value

`number`[] | `null`

##### Returns

`void`

***

### id

#### Get Signature

> **get** **id**(): `number`

Gets the reference to the object.

##### Returns

`number`

#### Inherited from

[`ObjectBase`](ObjectBase).[`id`](ObjectBase#id)

***

### om

#### Get Signature

> **get** **om**(): [`ObjectManager`](ObjectManager)

Gets the owner [ObjectManager](ObjectManager) instance.

##### Returns

[`ObjectManager`](ObjectManager)

#### Inherited from

[`ObjectBase`](ObjectBase).[`om`](ObjectBase#om)

***

### style

#### Get Signature

> **get** **style**(): [`BorderStyle`](../enumerations/BorderStyle)

Gets or sets the border style.

##### Returns

[`BorderStyle`](../enumerations/BorderStyle)

#### Set Signature

> **set** **style**(`value`): `void`

Gets or sets the border style.

##### Parameters

###### value

[`BorderStyle`](../enumerations/BorderStyle)

##### Returns

`void`

***

### width

#### Get Signature

> **get** **width**(): `number`

Gets or sets the border's width in points (1/72 inch).

##### Returns

`number`

#### Set Signature

> **set** **width**(`value`): `void`

Gets or sets the border's width in points (1/72 inch).

##### Parameters

###### value

`number`

##### Returns

`void`

## Methods

### free()

> **free**(): `void`

Detaches the object from the [ObjectManager](ObjectManager) and deallocates its memory, if possible.

#### Returns

`void`

#### Inherited from

[`ObjectBase`](ObjectBase).[`free`](ObjectBase#free)

***

### rebind()

> **rebind**(`omTo`): `void`

Rebinds the object from the current [ObjectManager](ObjectManager) to the specified one.

#### Parameters

##### omTo

[`ObjectManager`](ObjectManager)

The new [ObjectManager](ObjectManager) for the object.

#### Returns

`void`

#### Inherited from

[`ObjectBase`](ObjectBase).[`rebind`](ObjectBase#rebind)