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

    Type Alias WidgetProperties

    WidgetProperties: AnnotationBaseProperties & {
        activate?: ActionBase | ActionProperties;
        annotationPageClosed?: ActionBase | ActionProperties;
        annotationPageHide?: ActionBase | ActionProperties;
        annotationPageOpened?: ActionBase | ActionProperties;
        annotationPageShow?: ActionBase | ActionProperties;
        backColor?: Color;
        border?: BorderProperties;
        buttonAppearance?: ButtonAppearanceProperties;
        checkStyle?: CheckStyle;
        defaultAppearance?: DefaultAppearanceProperties | string;
        enter?: ActionBase | ActionProperties;
        highlighting?: HighlightingMode;
        justification?: VariableTextJustification;
        leave?: ActionBase | ActionProperties;
        mouseDown?: ActionBase | ActionProperties;
        mouseEnter?: ActionBase | ActionProperties;
        mouseLeave?: ActionBase | ActionProperties;
        mouseUp?: ActionBase | ActionProperties;
        name?: string;
        rotationAngle?: number;
    }

    Defines properties of a WidgetAnnotation.

    Type Declaration

    • Optionalactivate?: ActionBase | ActionProperties

      An action to be performed when the annotation is activated.

    • OptionalannotationPageClosed?: 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).

    • OptionalannotationPageHide?: ActionBase | ActionProperties

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

    • OptionalannotationPageOpened?: 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).

    • OptionalannotationPageShow?: ActionBase | ActionProperties

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

    • OptionalbackColor?: Color

      The annotation's background color.

    • Optionalborder?: BorderProperties

      The BorderProperties object defining annotation's border.

    • OptionalbuttonAppearance?: ButtonAppearanceProperties

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

    • OptionalcheckStyle?: 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.

    • OptionaldefaultAppearance?: 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".

    • Optionalenter?: ActionBase | ActionProperties

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

    • Optionalhighlighting?: HighlightingMode

      The annotation's highlighting mode.

    • Optionaljustification?: 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.

    • Optionalleave?: ActionBase | ActionProperties

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

    • OptionalmouseDown?: ActionBase | ActionProperties

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

    • OptionalmouseEnter?: ActionBase | ActionProperties

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

    • OptionalmouseLeave?: ActionBase | ActionProperties

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

    • OptionalmouseUp?: ActionBase | ActionProperties

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

    • Optionalname?: string

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

    • OptionalrotationAngle?: 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.

    Settings

    Member Visibility