ApiCheckboxWidget

Class representing a checkbox field widget.

ApiCheckboxWidget is a subclass of ApiBaseWidget.

Methods

The following table lists the available methods.

Method	Returns	Description
Delete	boolean	Removes widget from parent field.
GetActions	ApiActionCollection	Gets actions collection.
GetActionsJSON	JSON	Gets all field actions in json format.
GetBackgroundColor	ApiColor | null | undefined	Gets widget background color.
GetBorderColor	ApiColor | null | undefined	Gets widget border color.
GetBorderStyle	WidgetBorderStyle	Gets widget border style.
GetBorderWidth	WidgetBorderWidth	Gets widget border width.
GetCheckStyle	CheckStyle	Gets widget checkbox style.
GetClassType	"checkboxWidget"	Returns a type of the ApiCheckboxWidget class.
GetExportValue	string	Gets widget export value.
GetInternalId	string	Returns an internal ID of the current field widget.
GetParent	ApiField	Gets parent field.
GetPosition	Point	Gets widget position.
GetRect	Rect	Sets field rect.
GetTextAlign	WidgetTextAlign | undefined	Gets widget text alignment.
GetTextColor	ApiColor | null | undefined	Gets widget text color.
GetTextSize	hps	Gets widget text size.
IsAutoFit	boolean	Checks if text is autofit.
IsChecked	boolean	Checks if checkbox widget is checked.
IsCheckedByDefault	boolean	Checks if widget is checked by default.
SetAutoFit	boolean	Sets text autofit.
SetBackgroundColor	boolean	Sets widget background color.
SetBorderColor	boolean	Sets widget border color.
SetBorderStyle	boolean	Sets widget border style.
SetBorderWidth	boolean	Sets widget border width.
SetCheckStyle	boolean	Sets widget checkbox style.
SetChecked	boolean	Sets checkbox widget checked.
SetCheckedByDefault	boolean	Sets widget checked by default.
SetExportValue	boolean	Sets widget export value.
SetPosition	boolean	Sets widget position.
SetRect	boolean	Sets field rect.
SetTextAlign	boolean	Sets widget text alignment.
SetTextColor	boolean	Sets widget text color.
SetTextSize	boolean	Sets widget text size.