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

    Type Alias CheckBoxFieldProperties

    CheckBoxFieldProperties: FieldBaseProperties & {
        checked?: boolean;
        checkStyle?: CheckStyle;
        defaultChecked?: boolean;
        rect?: Rect;
        type: "checkbox";
        widget?: WidgetAnnotation | WidgetProperties;
    }

    Defines properties of a CheckBoxField.

    Type Declaration

    • Optionalchecked?: boolean

      The value as a Boolean value. Note, if both FieldBaseProperties#value and 'checked' are specified then 'checked' preffered.

    • OptionalcheckStyle?: CheckStyle

      The style of check mark.

      Note: If a widget is specified via the 'widget' property, its 'checkStyle' value takes precedence and will override this definition.

    • OptionaldefaultChecked?: boolean

      The default value as a Boolean value. Note, if both FieldBaseProperties#defaultValue and 'defaultChecked' are specified then 'defaultChecked' preffered.

    • Optionalrect?: Rect

      Defines the position and dimensions of the field on the page using a bounding rectangle.

      Note: If a widget is specified via the 'widget' property, its 'rect' value takes precedence and will override this rectangle definition.

    • type: "checkbox"
    • Optionalwidget?: WidgetAnnotation | WidgetProperties

      The widget annotation defining view properties of the checkbox field.