ApiCheckBoxForm

Represents the ApiCheckBoxForm class.

Methods

Method	Returns	Description
Clear	boolean	Clears the current form.
Copy	ApiForm	Copies the current form (copies with the shape if it exists).
GetChoiceName	string	Returns the choice name of the current radio button.
GetClassType	"checkBoxForm"	Returns a type of the ApiCheckBoxForm class.
GetFormKey	string	Returns the current form key.
GetFormType	FormType	Returns a type of the current form.
GetRadioGroup	string	Returns the radio group key if the current checkbox is a radio button.
GetRole	string	Returns the role of the current form.
GetTag	string	Returns the tag attribute for the current form.
GetText	string	Returns the text from the current form.
GetTextPr	ApiTextPr	Returns the text properties from the current form. Used if possible for this type of form
GetTipText	string	Returns the tip text of the current form.
GetWrapperShape	ApiShape	Returns a shape in which the form is placed to control the position and size of the fixed size form frame. The null value will be returned for the inline forms.
IsChecked	boolean	Returns the state of the current checkbox (checked or not).
IsFixed	boolean	Checks if the current form is fixed size.
IsRadioButton	boolean	Checks if the current checkbox is a radio button.
IsRequired	boolean	Checks if the current form is required.
MoveCursorOutside	boolean	Places a cursor before/after the current form.
SetBackgroundColor	boolean	Sets the background color to the current form.
SetBorderColor	boolean	Sets the border color to the current form.
SetChecked	boolean	Checks the current checkbox.
SetChoiceName	boolean	Sets the choice name for the current radio button.
SetFormKey	boolean	Sets a key to the current form.
SetPlaceholderText	boolean	Sets the placeholder text to the current form. Can't be set to checkbox or radio button.
SetRadioGroup	boolean	Sets the radio group key to the current radio button.
SetRequired	boolean	Specifies if the current form should be required.
SetRole	boolean	Sets the role to the current form.
SetTag	boolean	Sets the tag attribute to the current form.
SetTextPr	boolean	Sets the text properties to the current form. Used if possible for this type of form
SetTipText	boolean	Sets the tip text to the current form.
ToFixed	boolean	Converts the current form to a fixed size form.
ToInline	boolean	Converts the current form to an inline form. Picture form can't be converted to an inline form, it's always a fixed size object.