ApiButtonWidget
Class representing a button widget.
ApiButtonWidget is a subclass of ApiBaseWidget.
Methods
The following table lists the available methods.
| Method | Returns | Description |
|---|---|---|
| Delete | boolean | Removes widget from parent field. |
| GetActions | ApiActionCollection | Gets actions collection. |
| GetActionsJSON | JSON | Gets all field actions in json format. |
| GetBackgroundColor | ApiColor | null | undefined | Gets widget background color. |
| GetBehavior | ButtonBehavior | Gets button widget behavior. |
| GetBorderColor | ApiColor | null | undefined | Gets widget border color. |
| GetBorderStyle | WidgetBorderStyle | Gets widget border style. |
| GetBorderWidth | WidgetBorderWidth | Gets widget border width. |
| GetClassType | "buttonWidget" | Returns a type of the ApiButtonWidget class. |
| GetIconXPos | percentage | Gets button widget icon x position. |
| GetIconYPos | percentage | Gets button widget icon y position. |
| GetInternalId | string | Returns an internal ID of the current field widget. |
| GetLabel | string | null | undefined | Gets label from button widget field. |
| GetLayout | ButtonLayout | Gets button widget layout type |
| GetParent | ApiField | Gets parent field. |
| GetPosition | Point | Gets widget position. |
| GetRect | Rect | Sets field rect. |
| GetScaleHow | ButtonScaleHow | Gets button widget scale when type |
| GetScaleWhen | ButtonScaleWhen | Gets button widget scale when type |
| GetTextAlign | WidgetTextAlign | undefined | Gets widget text alignment. |
| GetTextColor | ApiColor | null | undefined | Gets widget text color. |
| GetTextSize | hps | Gets widget text size. |
| IsAutoFit | boolean | Checks if text is autofit. |
| IsFitBounds | boolean | Checks if button widget is fit bounds. |
| SetAutoFit | boolean | Sets text autofit. |
| SetBackgroundColor | boolean | Sets widget background color. |
| SetBehavior | boolean | Sets button widget behavior. |
| SetBorderColor | boolean | Sets widget border color. |
| SetBorderStyle | boolean | Sets widget border style. |
| SetBorderWidth | boolean | Sets widget border width. |
| SetFitBounds | boolean | Sets button widget fit bounds. |
| SetIconXPos | boolean | Sets button widget icon x position. |
| SetIconYPos | boolean | Sets button widget icon y position. |
| SetImage | boolean | Sets image to button widget field. |
| SetLabel | boolean | Sets label to button widget field. |
| SetLayout | boolean | Sets button widget layout type |
| SetPosition | boolean | Sets widget position. |
| SetRect | boolean | Sets field rect. |
| SetScaleHow | boolean | Sets button widget scale how type |
| SetScaleWhen | boolean | Sets button widget scale when type |
| SetTextAlign | boolean | Sets widget text alignment. |
| SetTextColor | boolean | Sets widget text color. |
| SetTextSize | boolean | Sets widget text size. |