ApiListboxField

ApiListboxField 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
Delete	boolean	Removes field from document.
GetAllWidgets	ApiWidget[]	Gets array with widgets of the current field.
GetClassType	"listboxField"	Returns a type of the ApiListboxField 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.
IsMultipleSelection	boolean	Checks if the field supports multiple selection.
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.
SetFullName	boolean	Sets new field name if possible.
SetMultipleSelection	boolean	Sets whether multiple values can be selected.
SetPartialName	boolean	Sets new field partial name.
SetReadOnly	boolean	Sets field read only
SetRequired	boolean	Sets field required
SetTooltip	boolean	Sets field tooltip
SetValue	boolean	Sets field value
SetValueIndexes	boolean	Sets selected value indexes.