DsPdfJS API - v9.1.0
    Preparing search index...

    Class RichMediaAnnotation

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

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    • get activationCondition(): string | null

      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 | null

    • set activationCondition(value: string | null): void

      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.

      Parameters

      • value: string | null

      Returns void

    • 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 contents(value: string | null): 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

    • get deactivationCondition(): string | null

      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 | null

    • set deactivationCondition(value: string | null): void

      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.

      Parameters

      • value: string | null

      Returns void

    • get flags(): AnnotationFlags

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

      Returns AnnotationFlags

    • set flags(value: AnnotationFlags): void

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

      Parameters

      Returns void

    • get id(): number

      Gets the reference to the object.

      Returns number

    • 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 locked(value: boolean): 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

    • 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 lockedContents(value: boolean): 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

    • get modifiedDate(): PdfDateTime | null

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

      Returns PdfDateTime | null

    • set modifiedDate(value: PdfDateTime | null): void

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

      Parameters

      Returns void

    • 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 name(value: string | null): 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

    • get page(): PdfPage | null

      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 | null

    • set page(value: PdfPage | null): void

      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.

      Parameters

      Returns void

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

      Returns Rect

      rect

    • set pdfRect(value: Rect): 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.

      Parameters

      Returns void

      rect

    • get presentationStyle(): string | null

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

      Returns string | null

    • set presentationStyle(value: string | null): 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 | null

      Returns void

    • 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 rect(value: Rect): 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

      Returns void

    • 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 showNavigationPane(value: boolean): void

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

      Parameters

      • value: boolean

      Returns void

    • 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 showToolbar(value: boolean): void

      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.

      Parameters

      • value: boolean

      Returns void

    Methods

    • 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

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

      Returns void