AnnotationBase

Abstract Class: AnnotationBase

The abstract base class for all PDF annotation types.

Extends

ObjectBase

Extended by

Accessors

appearanceStreams

Get Signature

get appearanceStreams(): AppearanceStreams;

Gets the AppearanceStreams object providing access to the annotation's appearance streams.

Returns

AppearanceStreams

associatedFiles

Get Signature

get associatedFiles(): AssociatedFiles;

Gets the list of embedded files associated with this annotation.

Returns

AssociatedFiles

Get Signature

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

set contents(value): void;

Parameters

value

string

Returns

void

doc

Get Signature

get doc(): PdfDocument;

Gets the PdfDocument owning this annotation.

Returns

PdfDocument

flags

Get Signature

get flags(): AnnotationFlags;

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

Returns

AnnotationFlags

Set Signature

set flags(value): void;

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

Parameters

value

AnnotationFlags

Returns

void

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ObjectBase.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;

Parameters

value

boolean

Returns

void

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;

Parameters

value

boolean

Returns

void

modifiedDate

Get Signature

get modifiedDate(): PdfDateTime;

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

Returns

PdfDateTime

Set Signature

set modifiedDate(value): void;

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

Parameters

value

PdfDateTime

Returns

void

name

Get Signature

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

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

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ObjectBase.om

page

Get Signature

get page(): PdfPage;

Gets or sets the 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 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

Set Signature

set page(value): void;

Parameters

value

PdfPage

Returns

void

pages

Get Signature

get pages(): AnnotationPagesCollection;

Gets the list of pages that reference this annotation.

Returns

AnnotationPagesCollection

pdfRect

Get Signature

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

Returns

Rect

Set Signature

set pdfRect(value): void;

See

rect

Parameters

value

Rect

Returns

void

rect

Get Signature

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

Set Signature

set rect(value): void;

Parameters

value

Rect

Returns

void

Methods

createAppearanceContentStream()

createAppearanceContentStream(): FormXObject;

Creates an instance of 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

The FormXObject object.

free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ObjectBase.free

rebind()

rebind(omTo): void;

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

ObjectBase.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

resetAppearance()

resetAppearance(): void;

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

Returns

void