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

    Class WidgetAnnotation

    Represents a widget annotation used in interactive forms to represent the appearance of fields and to manage user interactions.

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    • get annotationPageClosed(): ActionBase | null

      Gets or sets an action to be performed when the page containing the annotation is closed (for example, when the user navigates to the next or previous page, or follows a link annotation or outline item).

      Returns ActionBase | null

    • set annotationPageClosed(value: ActionProperties | ActionBase | null): void

      Gets or sets an action to be performed when the page containing the annotation is closed (for example, when the user navigates to the next or previous page, or follows a link annotation or outline item).

      Parameters

      Returns void

    • get annotationPageHide(): ActionBase | null

      Gets or sets an action to be performed when the page containing the annotation is no longer visible in the viewer application's user interface.

      Returns ActionBase | null

    • set annotationPageHide(value: ActionProperties | ActionBase | null): void

      Gets or sets an action to be performed when the page containing the annotation is no longer visible in the viewer application's user interface.

      Parameters

      Returns void

    • get annotationPageOpened(): ActionBase | null

      Gets or sets an action to be performed when the page containing the annotation is opened (for example, when the user navigates to it from the next or previous page or by means of a link annotation or outline item).

      Returns ActionBase | null

    • set annotationPageOpened(value: ActionProperties | ActionBase | null): void

      Gets or sets an action to be performed when the page containing the annotation is opened (for example, when the user navigates to it from the next or previous page or by means of a link annotation or outline item).

      Parameters

      Returns void

    • get annotationPageShow(): ActionBase | null

      Gets or sets an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.

      Returns ActionBase | null

    • set annotationPageShow(value: ActionProperties | ActionBase | null): void

      Gets or sets an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.

      Parameters

      Returns void

    • get backColor(): Color

      Gets or sets the annotation's background color.

      Returns Color

    • set backColor(value: Color): void

      Gets or sets the annotation's background color.

      Parameters

      Returns void

    • get checkStyle(): CheckStyle | null

      Gets or sets the style of check mark that is used if this WidgetAnnotation is linked with a CheckBoxField or a RadioButtonField.

      Note that this property works over the 'buttonAppearance.Caption' property, for example if 'checkStyle' is "Cross", then 'buttonAppearance.Caption' will be "8".

      If the value of this property is null, it indicates that ButtonAppearance.Caption contains an unknown value.

      Returns CheckStyle | null

    • set checkStyle(value: CheckStyle): void

      Gets or sets the style of check mark that is used if this WidgetAnnotation is linked with a CheckBoxField or a RadioButtonField.

      Note that this property works over the 'buttonAppearance.Caption' property, for example if 'checkStyle' is "Cross", then 'buttonAppearance.Caption' will be "8".

      If the value of this property is null, it indicates that ButtonAppearance.Caption contains an unknown value.

      Parameters

      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 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 mouseDown(): ActionBase | null

      Gets or sets an action to be performed when the mouse button is pressed inside the field's active area.

      Returns ActionBase | null

    • set mouseDown(value: ActionProperties | ActionBase | null): void

      Gets or sets an action to be performed when the mouse button is pressed inside the field's active area.

      Parameters

      Returns void

    • get mouseEnter(): ActionBase | null

      Gets or sets an action to be performed when the mouse enters the field's active area.

      Returns ActionBase | null

    • set mouseEnter(value: ActionProperties | ActionBase | null): void

      Gets or sets an action to be performed when the mouse enters the field's active area.

      Parameters

      Returns void

    • get mouseLeave(): ActionBase | null

      Gets or sets an action to be performed when the cursor exits the field's active area.

      Returns ActionBase | null

    • set mouseLeave(value: ActionProperties | ActionBase | null): void

      Gets or sets an action to be performed when the cursor exits the field's active area.

      Parameters

      Returns void

    • get mouseUp(): ActionBase | null

      Gets or sets an action to be performed when the mouse button is released inside the field's active area.

      Returns ActionBase | null

    • set mouseUp(value: ActionProperties | ActionBase | null): void

      Gets or sets an action to be performed when the mouse button is released inside the field's active area.

      Parameters

      Returns void

    • get name(): string | null

      Gets or sets the name of the annotation. If WidgetAnnotation is used with RadioButtonField then name is used as a value.

      Returns string | null

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

      Gets or sets the name of the annotation. If WidgetAnnotation is used with RadioButtonField then name is used as a value.

      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 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 rotationAngle(): number

      Gets or sets the angle, in degrees, by which the widget annotation is rotated counterclockwise relative to the page. The value must be a multiple of 90.

      Returns number

    • set rotationAngle(value: number): void

      Gets or sets the angle, in degrees, by which the widget annotation is rotated counterclockwise relative to the page. The value must be a multiple of 90.

      Parameters

      • value: number

      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