ApiTextForm
class ApiTextForm extends ApiFormBaseDescription
Class representing a document text field.
Instance Methods
- 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.
- SetAutoFit
(bAutoFit): 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.
- IsMultiline
(): boolean Checks if the current text field is multiline.
- SetMultiline
(bMultiline): boolean Specifies if the current text field should be miltiline.
- GetCharactersLimit
(): number Returns a limit of the text field characters.
- SetCharactersLimit
(nChars): boolean Sets a limit to the text field characters.
- IsComb
(): boolean Checks if the text field is a comb of characters with the same cell width.
- SetComb
(bComb): boolean Specifies if the text field should be a comb of characters with the same cell width.
- SetCellWidth
(nCellWidth): boolean Sets the cell width to the applied comb of characters.
- SetText
(sText): boolean Sets the text to the current text field.
- GetClassType
() Returns a type of the ApiFormBase class.
- GetFormType
() Returns a type of the current form.
- GetFormKey
() Returns the current form key.
- SetFormKey
(sKey) Sets a key to the current form.
- GetTipText
() Returns the tip text of the current form.
- SetTipText
(sText) Sets the tip text to the current form.
- IsRequired
() Checks if the current form is required.
- SetRequired
(bRequired) Specifies if the current form should be required.
- IsFixed
() Checks if the current form is fixed size.
- ToFixed
(nWidth, nHeight) Converts the current form to a fixed size form.
- ToInline
() Converts the current form to an inline form.
- SetBorderColor
(r, g, b, bNone) Sets the border color to the current form.
- SetBackgroundColor
(r, g, b, bNone) Sets the background color to the current form.
- GetText
() Returns the text from the current form.
- Clear
() Clears the current form.
- GetWrapperShape
() Returns a shape in which the form is placed to control the position and size of the fixed size form frame.
- SetPlaceholderText
(sText) Sets the placeholder text to the current form.
- SetTextPr
(oTextPr) Sets the text properties to the current form.
- GetTextPr
() Returns the text properties from the current form.
- MoveCursorOutside
(isAfter) Places a cursor before/after the current form.
- Copy
() Copies the current form (copies with the shape if it exists).
Extends
- ApiFormBase
Class representing a document form base.