ApiComboboxField

ApiComboboxField is a subclass of ApiBaseListField.

Methods

Method	Returns	Description
AddOption	boolean	Adds new option to list options.
AddWidget	ApiWidget	Adds new widget - visual representation for field
ClearFormat	boolean	Clears format of field.
Delete	boolean	Removes field from document.
GetAllWidgets	ApiWidget[]	Gets array with widgets of the current field.
GetClassType	"comboboxField"	Returns a type of the ApiComboboxField class.
GetFullName	string	Gets field full name.
GetInternalId	string	Returns an internal ID of the current field.
GetOption	ListOption	Gets option from list options.
GetOptions	ListOption[]	Gets all options from list options.
GetPartialName	string	Gets field partial name.
GetTooltip	boolean	Gets field tooltip
GetValue	string	Gets field value
GetValueIndexes	number[]	Gets selected value indexes.
IsCommitOnSelChange	boolean	Checks if field can commit on selection change.
IsEditable	boolean	Checks if field is editable.
IsReadOnly	boolean	Checks if field is read only
IsRequired	boolean	Checks if field is required
MoveOption	boolean	Moves option to specified position in list options.
RemoveOption	boolean	Removes option from list options.
SetCommitOnSelChange	boolean	Sets whether the field commits changes immediately after selection changes.
SetDateFormat	boolean	Sets date format for field.
SetEditable	boolean	Sets whether custom text can be entered.
SetFullName	boolean	Sets new field name if possible.
SetMask	boolean	Sets mask for field.
SetNumberFormat	boolean	Sets number format for field.
SetPartialName	boolean	Sets new field partial name.
SetPercentageFormat	boolean	Sets percentage format for field.
SetReadOnly	boolean	Sets field read only
SetRegularExp	boolean	Sets regular expression for field.
SetRequired	boolean	Sets field required
SetSpecialFormat	boolean	Sets special format for field.
SetTimeFormat	boolean	Sets time format for field.
SetTooltip	boolean	Sets field tooltip
SetValidateRange	boolean	Sets validate range for field.
SetValue	boolean	Sets field value
SetValueIndexes	boolean	Sets selected value indexes.