ApiTextForm

ApiTextForm is a subclass of ApiFormBase.

Methods

Method	Returns	Description
Clear	boolean	Clears the current form.
Copy	ApiForm	Copies the current form (copies with the shape if it exists).
Delete	boolean	Removes a form and its content. If keepContent is true, the content is not deleted.
GetAllowedSymbols	string	Returns the allowed symbols for the current text field.
GetBackgroundColor	ApiColor	Returns the background color of the current form.
GetBorderColor	ApiColor	Returns the border color of the current form.
GetCharactersLimit	number	Returns a limit of the text field characters.
GetClassType	"textForm"	Returns a type of the ApiTextForm class.
GetFormKey	string	Returns the current form key.
GetFormType	FormType	Returns a type of the current form.
GetFormat	TextFormFormat	Returns the format of the current text field.
GetInternalId	string	Returns an internal id of the current form.
GetLock	boolean	Returns the lock state of the current form.
GetPlaceholderText	string	Returns the placeholder text from the current form.
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.
GetTipText	string	Returns the tip text of the current form.
GetValue	string	Returns the current text value of the text form.
GetWrapperShape	ApiShape	Returns a shape in which the form is placed to control the position and size of the fixed size form frame.
IsAutoFit	boolean	Checks if the text field content is autofit, i.e. whether the font size adjusts to the size of the fixed size form.
IsComb	boolean	Checks if the text field is a comb of characters with the same cell width.
IsFilled	boolean	Checks if the current form is filled.
IsFixed	boolean	Checks if the current form is fixed size.
IsMultiline	boolean	Checks if the current text field is multiline.
IsRequired	boolean	Checks if the current form is required.
MoveCursorOutside	boolean	Places a cursor before/after the current form.
SetAllowedSymbols	boolean	Sets the allowed symbols for the current text field. Only the specified characters will be accepted as input.
SetAutoFit	boolean	Specifies if the text field content should be autofit, i.e. whether the font size adjusts to the size of the fixed size form.
SetBackgroundColor	boolean	Sets the background color to the current form.
SetBorderColor	boolean	Sets the border color to the current form.
SetCellWidth	boolean	Sets the cell width to the applied comb of characters.
SetCharactersLimit	boolean	Sets a limit to the text field characters.
SetComb	boolean	Specifies if the text field should be a comb of characters with the same cell width.
SetFormKey	boolean	Sets a key to the current form.
SetFormat	boolean	Sets the format for the current text field.
SetLock	boolean	Sets the lock state of the current form.
SetMultiline	boolean	Specifies if the current text field should be miltiline.
SetPlaceholderText	boolean	Sets the placeholder text to the current form.
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.
SetText	boolean	Sets the text to the current text field.
SetTextPr	boolean	Sets the text properties to the current form.
SetTipText	boolean	Sets the tip text to the current form.
SetValue	boolean	Sets the text value of the text form.
ToFixed	boolean	Converts the current form to a fixed size form.
ToInline	boolean	Converts the current form to an inline form.