Type Alias: CheckBoxFieldProperties

type CheckBoxFieldProperties = FieldBaseProperties & object;

Defines properties of a CheckBoxField.

Type Declaration

checked?

optional checked?: boolean;

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

checkStyle?

optional checkStyle?: 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.

defaultChecked?

optional defaultChecked?: boolean;

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

rect?

optional rect?: 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

type: "checkbox";

widget?

optional widget?: 
  | WidgetAnnotation
  | WidgetProperties;

The widget annotation defining view properties of the checkbox field.