Skip to main content

ApiCheckboxField

ApiCheckboxField is a subclass of ApiBaseField.

Methods

MethodReturnsDescription
AddOptionApiCheckboxWidgetAdds options to checkbox group.
AddWidgetApiWidgetAdds new widget - visual representation for field
DeletebooleanRemoves field from document.
GetAllWidgetsApiWidget[]Gets array with widgets of the current field.
GetClassType"checkboxField"Returns a type of the ApiCheckboxField class.
GetFullNamestringGets field full name.
GetPartialNamestringGets field partial name.
GetValuestringGets field value
IsReadOnlybooleanChecks if field is read only
IsRequiredbooleanChecks if field is required
IsToggleToOffbooleanChecks if field is toggle to off.
SetFullNamebooleanSets new field name if possible.
SetPartialNamebooleanSets new field partial name.
SetReadOnlybooleanSets field read only
SetRequiredbooleanSets field required
SetToggleToOffbooleanSets field toggle to off prop.
SetValuebooleanSets field value