Skip to main content

ApiBaseWidget

Class representing a base field widget.

Methods​

The following table lists the available methods.

MethodReturnsDescription
DeletebooleanRemoves widget from parent field.
GetActionsApiActionCollectionGets actions collection.
GetActionsJSONJSONGets all field actions in json format.
GetBackgroundColorApiColor | null | undefinedGets widget background color.
GetBorderColorApiColor | null | undefinedGets widget border color.
GetBorderStyleWidgetBorderStyleGets widget border style.
GetBorderWidthWidgetBorderWidthGets widget border width.
GetClassType"baseWidget"Returns a type of the ApiBaseWidget class.
GetInternalIdstringReturns an internal ID of the current field widget.
GetParentApiFieldGets parent field.
GetPositionPointGets widget position.
GetRectRectSets field rect.
GetTextAlignWidgetTextAlign | undefinedGets widget text alignment.
GetTextColorApiColor | null | undefinedGets widget text color.
GetTextSizehpsGets widget text size.
IsAutoFitbooleanChecks if text is autofit.
SetAutoFitbooleanSets text autofit.
SetBackgroundColorbooleanSets widget background color.
SetBorderColorbooleanSets widget border color.
SetBorderStylebooleanSets widget border style.
SetBorderWidthbooleanSets widget border width.
SetPositionbooleanSets widget position.
SetRectbooleanSets field rect.
SetTextAlignbooleanSets widget text alignment.
SetTextColorbooleanSets widget text color.
SetTextSizebooleanSets widget text size.