ApiTextForm

Represents the ApiTextForm class.

Methods

Method	Returns	Description
Clear	None	Clears the current form.
Copy	ApiForm	Copies the current form (copies with the shape if it exists).
GetCharactersLimit	number	Returns a limit of the text field characters.
GetClassType	"form"	Returns a type of the ApiFormBase class.
GetFormKey	string	Returns the current form key.
GetFormType	FormType	Returns a type of the current form.
GetText	string	Returns the text from the current form.\ Returns the value as a string if possible for the given form type*
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.
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.
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	None	Places a cursor before/after the current form.
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.\ The maximum number of characters must be set to a positive value.
SetFormKey	boolean	Sets a key to the current form.
SetMultiline	boolean	Specifies if the current text field should be miltiline.
SetPlaceholderText	boolean	Sets the placeholder text to the current form.\ Can't be set to checkbox or radio button.*
SetRequired	boolean	Specifies if the current form should be required.
SetText	boolean	Sets the text to the current text field.
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.*