SoundAnnotation

Class: SoundAnnotation

The SoundAnnotation is analogous to a text annotation except that instead of a text note, it contains sound recorded from the computer's microphone or imported from a file.

Extends

MarkupAnnotation

Constructors

Constructor

new SoundAnnotation(om): SoundAnnotation;

Creates a new SoundAnnotation.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the SoundAnnotation.

Returns

SoundAnnotation

Overrides

MarkupAnnotation.constructor

Constructor

new SoundAnnotation(): SoundAnnotation;

Creates a new SoundAnnotation.

Returns

SoundAnnotation

Overrides

MarkupAnnotation.constructor

Accessors

appearanceStreams

Get Signature

get appearanceStreams(): AppearanceStreams;

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

Returns

AppearanceStreams

Inherited from

MarkupAnnotation.appearanceStreams

associatedFiles

Get Signature

get associatedFiles(): AssociatedFiles;

Gets the list of embedded files associated with this annotation.

Returns

AssociatedFiles

Inherited from

MarkupAnnotation.associatedFiles

color

Get Signature

get color(): Color;

Gets or sets the annotation color, it used as color of popup window, lines color etc.

Returns

Color

Set Signature

set color(value): void;

Gets or sets the annotation color, it used as color of popup window, lines color etc.

Parameters

value

Color

Returns

void

Inherited from

MarkupAnnotation.color

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

Inherited from

MarkupAnnotation.contents

creationDate

Get Signature

get creationDate(): PdfDateTime;

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

Returns

PdfDateTime

Set Signature

set creationDate(value): void;

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

Parameters

value

PdfDateTime

Returns

void

Inherited from

MarkupAnnotation.creationDate

doc

Get Signature

get doc(): PdfDocument;

Gets the PdfDocument owning this annotation.

Returns

PdfDocument

Inherited from

MarkupAnnotation.doc

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

Inherited from

MarkupAnnotation.flags

icon

Get Signature

get icon(): string;

Gets or sets a string specifying the name of an icon used to display the annotation.

The PDF specification provides a predefined set of icons: "Speaker", "Mic" or "Ear".

Returns

string

Set Signature

set icon(value): void;

Gets or sets a string specifying the name of an icon used to display the annotation.

The PDF specification provides a predefined set of icons: "Speaker", "Mic" or "Ear".

Parameters

value

SoundAnnotationIcon

Returns

void

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

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

Inherited from

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

Parameters

value

boolean

Returns

void

Inherited from

MarkupAnnotation.lockedContents

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

Inherited from

MarkupAnnotation.modifiedDate

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

Inherited from

MarkupAnnotation.name

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

MarkupAnnotation.om

opacity

Get Signature

get opacity(): number;

Gets or sets the opacity value to be used in painting the annotation. This value applies to all visible elements of the annotation in its closed state (including its background and border) but not to the pop-up window that appears when the annotation is opened.

Returns

number

Set Signature

set opacity(value): void;

Parameters

value

number

Returns

void

Inherited from

MarkupAnnotation.opacity

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

Inherited from

MarkupAnnotation.page

pages

Get Signature

get pages(): AnnotationPagesCollection;

Gets the list of pages that reference this annotation.

Returns

AnnotationPagesCollection

Inherited from

MarkupAnnotation.pages

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

Inherited from

MarkupAnnotation.pdfRect

Get Signature

get popup(): PopupAnnotation;

Gets or sets the PopupAnnotation annotation for entering or editing text associated with this annotation. Setting this property changes the PopupAnnotation#parent property. A separate PopupAnnotation allows defining additional properties of the popup window: color, position etc.

Returns

PopupAnnotation

Set Signature

set popup(value): void;

Parameters

value

PopupAnnotation

Returns

void

Inherited from

MarkupAnnotation.popup

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

Inherited from

MarkupAnnotation.rect

referenceAnnotation

Get Signature

get referenceAnnotation(): MarkupAnnotation;

Gets or sets the annotation referenced by this annotation.

Returns

MarkupAnnotation

Set Signature

set referenceAnnotation(value): void;

Gets or sets the annotation referenced by this annotation.

Parameters

value

MarkupAnnotation

Returns

void

Inherited from

MarkupAnnotation.referenceAnnotation

referenceType

Get Signature

get referenceType(): string;

Gets or sets the relationship (reference type) between this annotation and the annotation specified by the 'referenceAnnotation' property. The referenced annotation should be on the same page with the current annotation. The valid values: "R" (reply), "Group"

Returns

string

Set Signature

set referenceType(value): void;

Parameters

value

AnnotationReferenceType

Returns

void

Inherited from

MarkupAnnotation.referenceType

richText

Get Signature

get richText(): string;

Gets or sets the text to be displayed in the pop-up window when the annotation is opened. This text can be formatted using HTML tags, see PDF specification for details.

Returns

string

Set Signature

set richText(value): void;

Gets or sets the text to be displayed in the pop-up window when the annotation is opened. This text can be formatted using HTML tags, see PDF specification for details.

Parameters

value

string

Returns

void

Inherited from

MarkupAnnotation.richText

sound

Get Signature

get sound(): SoundObject;

Gets or sets a SoundObject defining the sound to be played when the annotation is activated.

Returns

SoundObject

Set Signature

set sound(value): void;

Gets or sets a SoundObject defining the sound to be played when the annotation is activated.

Parameters

value

| SoundObject | SoundObjectProperties

Returns

void

subject

Get Signature

get subject(): string;

Gets or sets the text representing a short description of the subject being addressed by the annotation.

Returns

string

Set Signature

set subject(value): void;

Gets or sets the text representing a short description of the subject being addressed by the annotation.

Parameters

value

string

Returns

void

Inherited from

MarkupAnnotation.subject

userName

Get Signature

get userName(): string;

Gets or sets the text label to be displayed in the title bar of the annotation's pop-up window when open and active. By convention, this entry identifies the user who added the annotation.

Returns

string

Set Signature

set userName(value): void;

Gets or sets the text label to be displayed in the title bar of the annotation's pop-up window when open and active. By convention, this entry identifies the user who added the annotation.

Parameters

value

string

Returns

void

Inherited from

MarkupAnnotation.userName

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.

Inherited from

MarkupAnnotation.createAppearanceContentStream

free()

free(): void;

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

Returns

void

Inherited from

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

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

MarkupAnnotation.removeAppearance

resetAppearance()

resetAppearance(): void;

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

Returns

void

Inherited from

MarkupAnnotation.resetAppearance