ApiComplexForm
Class representing a complex form.
Methods
| Name |
Description |
| Clear |
Clears the current form. |
| Copy |
Copies the current form (copies with the shape if it exists). |
| GetClassType |
Returns a type of the ApiFormBase class. |
| GetFormKey |
Returns the current form key. |
| GetFormType |
Returns a type of the current form. |
| GetText |
Returns the text from the current form.
This method is used only for text and combo box forms. |
| GetTextPr |
Returns the text properties from the current form.
This method is used only for text and combo box forms. |
| GetTipText |
Returns the tip text of 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.
The null value will be returned for the inline forms. |
| IsFixed |
Checks if the current form is fixed size. |
| IsRequired |
Checks if the current form is required. |
| SetBackgroundColor |
Sets the background color to the current form. |
| SetBorderColor |
Sets the border color to the current form. |
| SetFormKey |
Sets a key to the current form. |
| SetPlaceholderText |
Sets the placeholder text to the current form.
Can't be set to checkbox or radio button. |
| SetRequired |
Specifies if the current form should be required. |
| SetTextPr |
Sets the text properties to the current form.
This method is used only for text and combo box forms. |
| SetTipText |
Sets the tip text to the current form. |
| ToFixed |
Converts the current form to a fixed size form. |
| ToInline |
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. |