# PopupAnnotation

## Content

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

***

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

# Class: PopupAnnotation

Reprensets an annotation displays text in a popup window for entry and editing.
It shall not appear alone but is associated with a [MarkupAnnotation](MarkupAnnotation),
its parent annotation, and shall be used for editing the parent's text.

## Extends

- [`AnnotationBase`](AnnotationBase)

## Constructors

### Constructor

> **new PopupAnnotation**(`om`): `PopupAnnotation`

Creates a new PopupAnnotation.

#### Parameters

##### om

[`ObjectManager`](ObjectManager)

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

#### Returns

`PopupAnnotation`

#### Overrides

`AnnotationBase.constructor`

### Constructor

> **new PopupAnnotation**(): `PopupAnnotation`

Creates a new PopupAnnotation.

#### Returns

`PopupAnnotation`

#### Overrides

`AnnotationBase.constructor`

## Accessors

### color

#### Get Signature

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

Gets or sets the popup window color.

##### Returns

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

#### Set Signature

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

Gets or sets the popup window color.

##### Parameters

###### value

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

##### Returns

`void`

***

### contents

#### Get Signature

> **get** **contents**(): `string` \| `null`

Gets or sets the text to be displayed for the annotation or,
if this type of annotation does not display text,
an alternate description of the annotation's contents in human-readable form.
In either case, this text is useful when extracting the document's contents in support of accessibility
to users with disabilities or for other purposes.

##### Returns

`string` \| `null`

#### Set Signature

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

Gets or sets the text to be displayed for the annotation or,
if this type of annotation does not display text,
an alternate description of the annotation's contents in human-readable form.
In either case, this text is useful when extracting the document's contents in support of accessibility
to users with disabilities or for other purposes.

##### Parameters

###### value

`string` | `null`

##### Returns

`void`

#### Inherited from

[`AnnotationBase`](AnnotationBase).[`contents`](AnnotationBase#contents)

***

### doc

#### Get Signature

> **get** **doc**(): [`PdfDocument`](PdfDocument) \| `null`

Gets the [PdfDocument](PdfDocument) owning this annotation.

##### Returns

[`PdfDocument`](PdfDocument) \| `null`

#### Inherited from

[`RichMediaAnnotation`](RichMediaAnnotation).[`doc`](RichMediaAnnotation#doc)

***

### flags

#### Get Signature

> **get** **flags**(): [`AnnotationFlags`](../enumerations/AnnotationFlags)

Gets or sets the flags specifying various characteristics of the annotation.

##### Returns

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

#### Set Signature

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

Gets or sets the flags specifying various characteristics of the annotation.

##### Parameters

###### value

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

##### Returns

`void`

#### Inherited from

[`AnnotationBase`](AnnotationBase).[`flags`](AnnotationBase#flags)

***

### id

#### Get Signature

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

Gets the reference to the object.

##### Returns

`number`

#### Inherited from

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

***

### locked

#### Get Signature

> **get** **locked**(): `boolean`

Gets or sets a value indicating whether the annotation can be deleted or its properties (including position and size) can be modified by the user.
However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.

##### Returns

`boolean`

#### Set Signature

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

Gets or sets a value indicating whether the annotation can be deleted or its properties (including position and size) can be modified by the user.
However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.

##### Parameters

###### value

`boolean`

##### Returns

`void`

#### Inherited from

[`AnnotationBase`](AnnotationBase).[`locked`](AnnotationBase#locked)

***

### lockedContents

#### Get Signature

> **get** **lockedContents**(): `boolean`

Gets or sets a value indicating whether the contents of the annotation can be modified by the user.
This flag does not restrict deletion of the annotation or changes to other annotation properties,
such as position and size.

##### Returns

`boolean`

#### Set Signature

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

Gets or sets a value indicating whether the contents of the annotation can be modified by the user.
This flag does not restrict deletion of the annotation or changes to other annotation properties,
such as position and size.

##### Parameters

###### value

`boolean`

##### Returns

`void`

#### Inherited from

[`AnnotationBase`](AnnotationBase).[`lockedContents`](AnnotationBase#lockedcontents)

***

### modifiedDate

#### Get Signature

> **get** **modifiedDate**(): [`PdfDateTime`](../type-aliases/PdfDateTime) \| `null`

Gets or sets the date and time when the annotation was modified.

##### Returns

[`PdfDateTime`](../type-aliases/PdfDateTime) \| `null`

#### Set Signature

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

Gets or sets the date and time when the annotation was modified.

##### Parameters

###### value

[`PdfDateTime`](../type-aliases/PdfDateTime) | `null`

##### Returns

`void`

#### Inherited from

[`AnnotationBase`](AnnotationBase).[`modifiedDate`](AnnotationBase#modifieddate)

***

### name

#### Get Signature

> **get** **name**(): `string` \| `null`

Gets or sets the annotation name, a text string uniquely identifying it among all annotations on its page.

##### Returns

`string` \| `null`

#### Set Signature

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

Gets or sets the annotation name, a text string uniquely identifying it among all annotations on its page.

##### Parameters

###### value

`string` | `null`

##### Returns

`void`

#### Inherited from

[`AnnotationBase`](AnnotationBase).[`name`](AnnotationBase#name)

***

### om

#### Get Signature

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

Gets the owner [ObjectManager](ObjectManager) instance.

##### Returns

[`ObjectManager`](ObjectManager)

#### Inherited from

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

***

### open

#### Get Signature

> **get** **open**(): `boolean`

Gets or sets a value specifying whether the pop-up annotation should initially
be displayed open.

##### Returns

`boolean`

#### Set Signature

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

Gets or sets a value specifying whether the pop-up annotation should initially
be displayed open.

##### Parameters

###### value

`boolean`

##### Returns

`void`

***

### page

#### Get Signature

> **get** **page**(): [`PdfPage`](PdfPage) \| `null`

Gets or sets the [PdfPage](PdfPage) that contains this annotation.
Note that an annotation may be referenced by several pages.
In that case this property returns the first element in the 
[pages](AnnotationBase#pages) collection.
When setting this property, the following applies:
If the new value is null, this annotation is removed from all pages.
Otherwise, this annotation is assigned exclusively to the specified page.

##### Returns

[`PdfPage`](PdfPage) \| `null`

#### Set Signature

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

Gets or sets the [PdfPage](PdfPage) that contains this annotation.
Note that an annotation may be referenced by several pages.
In that case this property returns the first element in the 
[pages](AnnotationBase#pages) collection.
When setting this property, the following applies:
If the new value is null, this annotation is removed from all pages.
Otherwise, this annotation is assigned exclusively to the specified page.

##### Parameters

###### value

[`PdfPage`](PdfPage) | `null`

##### Returns

`void`

#### Inherited from

[`UnknownAnnotation`](UnknownAnnotation).[`page`](UnknownAnnotation#page)

***

### pages

#### Get Signature

> **get** **pages**(): [`AnnotationPagesCollection`](AnnotationPagesCollection)

Gets the list of pages that reference this annotation.

##### Returns

[`AnnotationPagesCollection`](AnnotationPagesCollection)

#### Inherited from

[`AnnotationBase`](AnnotationBase).[`pages`](AnnotationBase#pages)

***

### parent

#### Get Signature

> **get** **parent**(): [`MarkupAnnotation`](MarkupAnnotation) \| `null`

Gets the parent [MarkupAnnotation](MarkupAnnotation) of the current annotation.
This property changes when the [MarkupAnnotation#referenceAnnotation](MarkupAnnotation#referenceannotation) is changed.

##### Returns

[`MarkupAnnotation`](MarkupAnnotation) \| `null`

***

### pdfRect

#### Get Signature

> **get** **pdfRect**(): [`Rect`](../type-aliases/Rect)

Gets or sets the rectangle that defines the location and size of the annotation on a page
in PDF user space coordinates. 
The positive X axis extends horizontally to the right, and the positive Y axis
extends vertically upward, with the origin usually in the lower left corner of the page.

##### See

[rect](AnnotationBase#rect)

##### Returns

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

#### Set Signature

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

Gets or sets the rectangle that defines the location and size of the annotation on a page
in PDF user space coordinates. 
The positive X axis extends horizontally to the right, and the positive Y axis
extends vertically upward, with the origin usually in the lower left corner of the page.

##### See

[rect](AnnotationBase#rect)

##### Parameters

###### value

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

##### Returns

`void`

#### Inherited from

[`AnnotationBase`](AnnotationBase).[`pdfRect`](AnnotationBase#pdfrect)

***

### rect

#### Get Signature

> **get** **rect**(): [`Rect`](../type-aliases/Rect)

Gets or sets the rectangle that defines the location and size of the annotation on a page.
The coordinates of the rectangle are relative to the upper left corner of the page's
media box, with the Y (vertical) coordinates increasing from top to bottom.
Note that if the annotation is associated with more than one page,
the media box of the first of those pages is used to calculate the rectangle's location.

##### Returns

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

#### Set Signature

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

Gets or sets the rectangle that defines the location and size of the annotation on a page.
The coordinates of the rectangle are relative to the upper left corner of the page's
media box, with the Y (vertical) coordinates increasing from top to bottom.
Note that if the annotation is associated with more than one page,
the media box of the first of those pages is used to calculate the rectangle's location.

##### Parameters

###### value

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

##### Returns

`void`

#### Inherited from

[`UnknownAnnotation`](UnknownAnnotation).[`rect`](UnknownAnnotation#rect)

## Methods

### free()

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

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

#### Returns

`void`

#### Inherited from

[`AnnotationBase`](AnnotationBase).[`free`](AnnotationBase#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

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

***

### removeAppearance()

> **removeAppearance**(): `void`

Removes all appearance streams associated with the current annotation,
and disables generation of appearance steams for this annotation when the document is saved.

Note that if any property affecting the annotation's appearance 'rect' is then changed,
the appearance streams will be regenerated. So this method would usually be called after
initializing all annotation's properties.

#### Returns

`void`

#### Inherited from

[`AnnotationBase`](AnnotationBase).[`removeAppearance`](AnnotationBase#removeappearance)

***

### resetAppearance()

> **resetAppearance**(): `void`

Forces regeneration of the annotation's appearance streams
next time the document is saved.

#### Returns

`void`

#### Inherited from

[`AnnotationBase`](AnnotationBase).[`resetAppearance`](AnnotationBase#resetappearance)