RichMediaAnnotation

Class: RichMediaAnnotation

Represents a rich media annotation. Rich media annotations provide a common framework for video, audio, animations and other multimedia presentations.

Extends

AnnotationBase

Constructors

Constructor

new RichMediaAnnotation(om): RichMediaAnnotation;

Creates a new RichMediaAnnotation.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the RichMediaAnnotation.

Returns

RichMediaAnnotation

Overrides

AnnotationBase.constructor

Constructor

new RichMediaAnnotation(): RichMediaAnnotation;

Creates a new RichMediaAnnotation.

Returns

RichMediaAnnotation

Overrides

AnnotationBase.constructor

Accessors

activationCondition

Get Signature

get activationCondition(): string;

Gets or sets the string specifying the circumstances under which the annotation shall be activated, the valid values: "XA" - The annotation is explicitly activated by a user action or script. "PO" - The annotation is activated as soon as the page that contains the annotation receives focus as the current page. "PV" - The annotation is activated as soon as any part of the page that contains the annotation becomes visible.

Returns

string

Set Signature

set activationCondition(value): void;

Parameters

value

string

Returns

void

appearanceStreams

Get Signature

get appearanceStreams(): AppearanceStreams;

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

Returns

AppearanceStreams

Inherited from

AnnotationBase.appearanceStreams

associatedFiles

Get Signature

get associatedFiles(): AssociatedFiles;

Gets the list of embedded files associated with this annotation.

Returns

AssociatedFiles

Inherited from

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

Inherited from

AnnotationBase.contents

deactivationCondition

Get Signature

get deactivationCondition(): string;

Gets or sets the string specifying the circumstances under which the annotation shall be deactivated, the valid values: "XD" - The annotation is explicitly deactivated by a user action or script. "PC" - The annotation is deactivated as soon as the page that contains the annotation loses focus as the current page. "PI" - The annotation is deactivated as soon as the entire page that contains the annotation is no longer visible.

Returns

string

Set Signature

set deactivationCondition(value): void;

Parameters

value

string

Returns

void

doc

Get Signature

get doc(): PdfDocument;

Gets the PdfDocument owning this annotation.

Returns

PdfDocument

Inherited from

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

AnnotationBase.flags

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

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;

Parameters

value

boolean

Returns

void

Inherited from

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;

Parameters

value

boolean

Returns

void

Inherited from

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

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

AnnotationBase.name

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

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

Inherited from

AnnotationBase.page

pages

Get Signature

get pages(): AnnotationPagesCollection;

Gets the list of pages that reference this annotation.

Returns

AnnotationPagesCollection

Inherited from

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

AnnotationBase.pdfRect

presentationStyle

Get Signature

get presentationStyle(): string;

Gets or sets the string specifying the style of presentation of the rich media (embedded or windowed), the valid values: "Embedded", "Windowed"

Returns

string

Set Signature

set presentationStyle(value): void;

Gets or sets the string specifying the style of presentation of the rich media (embedded or windowed), the valid values: "Embedded", "Windowed"

Parameters

value

string

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

Inherited from

AnnotationBase.rect

showNavigationPane

Get Signature

get showNavigationPane(): boolean;

Gets or sets a value indicating the default behavior of a navigation pane user interface element. If "true", the navigation pane should be visible when the content is initially activated. If "false", the navigation pane should not be displayed. The default is "false".

Returns

boolean

Set Signature

set showNavigationPane(value): void;

Parameters

value

boolean

Returns

void

showToolbar

Get Signature

get showToolbar(): boolean;

Gets or sets the value indicating the default behavior of an interactive toolbar associated with this annotation. If "true", the toolbar should be displayed when the annotation is activated and given focus. If "false", the toolbar should not be displayed.

Returns

boolean

Set Signature

set showToolbar(value): void;

Parameters

value

boolean

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.

Inherited from

AnnotationBase.createAppearanceContentStream

free()

free(): void;

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

Returns

void

Inherited from

AnnotationBase.free

getContent()

getContent(): object;

Gets an object containing FileSpecification object representing the content associated with this RichMediaAnnotation and value specifying the type of content audio or video.

Returns

object

content

content: FileSpecification;

type

type: RichMediaAnnotationContentType;

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

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

resetAppearance()

resetAppearance(): void;

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

Returns

void

Inherited from

AnnotationBase.resetAppearance

setAudio()

setAudio(value): void;

Sets the content of this RichMediaAnnotation to the audio represented by a FileSpecification object.

Parameters

value

| FileSpecification | FileSpecificationProperties

The FileSpecification object representing the audio content.

Returns

void

setContent()

setContent(content, contentType): void;

Sets the content of this RichMediaAnnotation.

Parameters

content

| FileSpecification | FileSpecificationProperties

The FileSpecification object representing the content.

contentType

RichMediaAnnotationContentType

The content type.

Returns

void

setVideo()

setVideo(value): void;

Sets the content of this RichMediaAnnotation to the video represented by a FileSpecification object.

Parameters

value

| FileSpecification | FileSpecificationProperties

The FileSpecification object representing the video content.

Returns

void