ApiComplexForm
Represents the ApiComplexForm class.
Methods
| Method | Returns | Description |
|---|---|---|
| Add | boolean | Appends the text content of the given form to the end of the current complex form. |
| Clear | boolean | Clears the current form. |
| ClearContent | boolean | Clears all content from the current complex form, resetting it to its placeholder state. |
| Copy | ApiForm | Copies the current form (copies with the shape if it exists). |
| 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. |
| GetRole | string | Returns the role of the current form. |
| GetSubForms | ApiForm[] | Returns an ordered list of subforms. |
| 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. |
| IsFixed | boolean | Checks if the current form is fixed size. |
| 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. |
| 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.* |
| 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.* |