ApiTextField

ApiTextField is a subclass of ApiBaseField.

Methods

Method	Returns	Description
AddWidget	ApiWidget	Adds new widget - visual representation for field
ClearFormat	boolean	Clears format of field.
Delete	boolean	Removes field from document.
GetAllWidgets	ApiWidget[]	Gets array with widgets of the current field.
GetCharLimit	number	Gets the text field character limit.
GetClassType	"textField"	Returns a type of the ApiTextField class.
GetFullName	string	Gets field full name.
GetInternalId	string	Returns an internal ID of the current field.
GetPartialName	string	Gets field partial name.
GetTooltip	boolean	Gets field tooltip
GetValue	string	Gets field value
IsComb	boolean	Checks if the text field uses comb formatting.
IsMultiline	boolean	Checks if text field is multiline.
IsReadOnly	boolean	Checks if field is read only
IsRequired	boolean	Checks if field is required
IsScrollLongText	boolean	Checks if text field can scroll long text.
SetCharLimit	boolean	Sets the text field character limit.
SetComb	boolean	Sets whether the text field uses comb formatting.
SetDateFormat	boolean	Sets date format for field.
SetFullName	boolean	Sets new field name if possible.
SetMask	boolean	Sets the input mask for entered text.
SetMultiline	boolean	Sets text field multiline prop.
SetNumberFormat	boolean	Sets number format for field.
SetPartialName	boolean	Sets new field partial name.
SetPercentageFormat	boolean	Sets percentage format for field.
SetReadOnly	boolean	Sets field read only
SetRegularExp	boolean	Sets regular expression validate string for field.
SetRequired	boolean	Sets field required
SetScrollLongText	boolean	Sets whether the text field can scroll long text.
SetSpecialFormat	boolean	Sets special format for field.
SetTimeFormat	boolean	Sets time format for field.
SetTooltip	boolean	Sets field tooltip
SetValidateRange	boolean	Sets validate range for field.
SetValue	boolean	Sets field value