DsPdfJS API v9.1.0

---

DsPdfJS API / WidgetProperties

Type Alias: WidgetProperties

WidgetProperties = AnnotationBaseProperties & object

Defines properties of a WidgetAnnotation.

Type Declaration

activate?

optional activate: ActionBase | ActionProperties

An action to be performed when the annotation is activated.

annotationPageClosed?

optional annotationPageClosed: ActionBase | ActionProperties

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

annotationPageHide?

optional annotationPageHide: ActionBase | ActionProperties

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

annotationPageOpened?

optional annotationPageOpened: ActionBase | ActionProperties

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

annotationPageShow?

optional annotationPageShow: ActionBase | ActionProperties

An action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.

backColor?

optional backColor: Color

The annotation's background color.

border?

optional border: BorderProperties

The BorderProperties object defining annotation's border.

buttonAppearance?

optional buttonAppearance: ButtonAppearanceProperties

The ButtonAppearanceProperties object that specifies the look of the widget if it is linked with a push button field.

checkStyle?

optional checkStyle: CheckStyle

The style of check mark that is used if a 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.

defaultAppearance?

optional defaultAppearance: DefaultAppearanceProperties | string

The apperance that specifies the visual properties (font, font size etc.) used to format the content of the annotation. The apperance can be specified as DefaultAppearanceProperties with set of properties like font, fontSize, foreColor or as a string as it will be stored in a PDF stream: "/DF0 10 Tf 0 0 0 rg".

enter?

optional enter: ActionBase | ActionProperties

An action to be performed when the annotation receives the input focus.

highlighting?

optional highlighting: HighlightingMode

The annotation's highlighting mode.

justification?

optional justification: VariableTextJustification

The justification to be used in displaying the annotation's text. Note that if this property is not specified (the value is null) then Field#justification is used. See PDF specification for details.

leave?

optional leave: ActionBase | ActionProperties

An action to be performed when the annotation loses the input focus.

mouseDown?

optional mouseDown: ActionBase | ActionProperties

An action to be performed when the mouse button is pressed inside the field's active area.

mouseEnter?

optional mouseEnter: ActionBase | ActionProperties

An action to be performed when the mouse enters the field's active area.

mouseLeave?

optional mouseLeave: ActionBase | ActionProperties

An action to be performed when the cursor exits the field's active area.

mouseUp?

optional mouseUp: ActionBase | ActionProperties

An action to be performed when the mouse button is released inside the field's active area.

name?

optional name: string

The name of the annotation. If WidgetAnnotation is used with RadioButtonField then 'name' is used as a value.

rotationAngle?

optional rotationAngle: number

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