# AnnotationBase

## Content

# Abstract Class: AnnotationBase

The abstract base class for all PDF annotation types.

## Extends

- [`ObjectBase`](ObjectBase)

## Extended by

- [`MarkupAnnotation`](MarkupAnnotation)
- [`LinkAnnotation`](LinkAnnotation)
- [`PopupAnnotation`](PopupAnnotation)
- [`UnknownAnnotation`](UnknownAnnotation)
- [`WatermarkAnnotation`](WatermarkAnnotation)
- [`WidgetAnnotation`](WidgetAnnotation)
- [`RichMediaAnnotation`](RichMediaAnnotation)
- [`Model3DAnnotation`](Model3DAnnotation)

## Accessors

### appearanceStreams

#### Get Signature

```ts
get appearanceStreams(): AppearanceStreams;
```

Gets the [AppearanceStreams](AppearanceStreams) object providing access to the annotation's appearance streams.

##### Returns

[`AppearanceStreams`](AppearanceStreams)

***

### associatedFiles

#### Get Signature

```ts
get associatedFiles(): AssociatedFiles;
```

Gets the list of embedded files associated with this annotation.

##### Returns

[`AssociatedFiles`](AssociatedFiles)

***

### contents

#### Get Signature

```ts
get contents(): string;
```

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`

#### Set Signature

```ts
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`

##### Returns

`void`

***

### doc

#### Get Signature

```ts
get doc(): PdfDocument;
```

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

##### Returns

[`PdfDocument`](PdfDocument)

***

### flags

#### Get Signature

```ts
get flags(): AnnotationFlags;
```

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

##### Returns

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

#### Set Signature

```ts
set flags(value): void;
```

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

##### Parameters

###### value

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

##### Returns

`void`

***

### id

#### Get Signature

```ts
get id(): number;
```

Gets the reference to the object.

##### Returns

`number`

#### Inherited from

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

***

### locked

#### Get Signature

```ts
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

```ts
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`

***

### lockedContents

#### Get Signature

```ts
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

```ts
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`

***

### modifiedDate

#### Get Signature

```ts
get modifiedDate(): PdfDateTime;
```

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

##### Returns

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

#### Set Signature

```ts
set modifiedDate(value): void;
```

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

##### Parameters

###### value

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

##### Returns

`void`

***

### name

#### Get Signature

```ts
get name(): string;
```

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

##### Returns

`string`

#### Set Signature

```ts
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`

##### Returns

`void`

***

### om

#### Get Signature

```ts
get om(): ObjectManager;
```

Gets the owner [ObjectManager](ObjectManager) instance.

##### Returns

[`ObjectManager`](ObjectManager)

#### Inherited from

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

***

### page

#### Get Signature

```ts
get page(): PdfPage;
```

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](#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)

#### Set Signature

```ts
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](#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)

##### Returns

`void`

***

### pages

#### Get Signature

```ts
get pages(): AnnotationPagesCollection;
```

Gets the list of pages that reference this annotation.

##### Returns

[`AnnotationPagesCollection`](AnnotationPagesCollection)

***

### pdfRect

#### Get Signature

```ts
get pdfRect(): 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](#rect)

##### Returns

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

#### Set Signature

```ts
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](#rect)

##### Parameters

###### value

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

##### Returns

`void`

***

### rect

#### Get Signature

```ts
get rect(): 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

```ts
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`

## Methods

### createAppearanceContentStream()

```ts
createAppearanceContentStream(): FormXObject;
```

Creates an instance of [FormXObject](FormXObject) that can be used
to define the annotation's appearance stream.
Note that when this method is called, the annotation must already
have been added to the document, otherwise an exception will be thrown.

#### Returns

[`FormXObject`](FormXObject)

The [FormXObject](FormXObject) object.

***

### free()

```ts
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()

```ts
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)

***

### removeAppearance()

```ts
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`

***

### resetAppearance()

```ts
resetAppearance(): void;
```

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

#### Returns

`void`