ApiPictureForm
Represents the ApiPictureForm class.
Methods
| Method | Returns | Description |
|---|---|---|
| Clear | None | Clears the current form. |
| 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. |
| GetImage | Base64Img | Returns an image in the base64 format from the current picture form. |
| GetPicturePosition | percentage[] | Returns the picture position inside the current form. |
| GetScaleFlag | ScaleFlag | Returns the current scaling condition of the picture 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. |
| IsFixed | boolean | Checks if the current form is fixed size. |
| IsLockAspectRatio | boolean | Checks if the aspect ratio of the current picture form is locked or not. |
| IsRequired | boolean | Checks if the current form is required. |
| IsRespectBorders | boolean | Checks if the form border width is respected or not. |
| MoveCursorOutside | None | 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. |
| SetImage | boolean | Sets an image to the current picture form. |
| SetLockAspectRatio | boolean | Locks the aspect ratio of the current picture form. |
| SetPicturePosition | boolean | Sets the picture position inside the current form:\ -0 - the picture is placed on the left/top;\ -50 - the picture is placed in the center;\ -100 - the picture is placed on the right/bottom. |
| 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. |
| SetRespectBorders | boolean | Respects the form border width when scaling the image. |
| SetScaleFlag | boolean | Sets the scaling condition to the current picture 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.* |