import { ObjectManager } from "../../ObjectManager"; import { ChoiceField, type ChoiceFieldProperties } from "./ChoiceField"; /** * Defines properties of a {@link ComboBoxField}. */ export type ComboBoxFieldProperties = ChoiceFieldProperties & { type: "combobox"; /** * The string value of this {@link ComboBoxField}. * * The behavior varies based on the 'editable' property: * - When 'editable' is false: returns the text of the selected item from the 'items' collection * - When 'editable' is true: allows getting/setting any custom string value, regardless of the 'items' collection */ text?: string; /** * The default value of this {@link ComboBoxField} as a string. * * The behavior varies based on the 'editable' property: * - When 'editable' is false: returns the text of the selected item from the 'items' collection * - When 'editable' is true: allows getting/setting any custom string value, regardless of the 'items' collection */ defaultText?: string; /** * The value of {@link ComboBoxField}, * value is specified as index of selected item. */ value?: number; /** * The default value of {@link ComboBoxField}, * value is specified as index of selected item. */ defaultValue?: number; /** * Indicating whether the combo box includes an editable text box as well * as a drop-down list. */ editable?: boolean; }; /** * Represents the ComboBox field. */ export declare class ComboBoxField extends ChoiceField { /** * Creates a new {@link ComboBoxField}. * * @param om - {@link ObjectManager} that controls the lifetime of the {@link ComboBoxField}. */ constructor(om: ObjectManager); /** * Creates a new {@link ComboBoxField}. */ constructor(); /** * Gets or sets the string value of this {@link ComboBoxField}. * * The behavior varies based on the 'editable' property: * - When 'editable' is false: returns the text of the selected item from the 'items' collection * - When 'editable' is true: allows getting/setting any custom string value, regardless of the 'items' collection */ get text(): string; /** * Gets or sets the string value of this {@link ComboBoxField}. * * The behavior varies based on the 'editable' property: * - When 'editable' is false: returns the text of the selected item from the 'items' collection * - When 'editable' is true: allows getting/setting any custom string value, regardless of the 'items' collection */ set text(value: string); /** * Gets or sets the default value of this {@link ComboBoxField} as a string. * * The behavior varies based on the 'editable' property: * - When 'editable' is false: returns the text of the selected item from the 'items' collection * - When 'editable' is true: allows getting/setting any custom string value, regardless of the 'items' collection */ get defaultText(): string; /** * Gets or sets the default value of this {@link ComboBoxField} as a string. * * The behavior varies based on the 'editable' property: * - When 'editable' is false: returns the text of the selected item from the 'items' collection * - When 'editable' is true: allows getting/setting any custom string value, regardless of the 'items' collection */ set defaultText(value: string); /** * Gets or sets the value of {@link ComboBoxField}, * value is specified as index of selected item. */ get value(): number; /** * Gets or sets the value of {@link ComboBoxField}, * value is specified as index of selected item. */ set value(value: number); /** * Gets or sets the default value of {@link ComboBoxField}, * value is specified as index of selected item. */ get defaultValue(): number; /** * Gets or sets the default value of {@link ComboBoxField}, * value is specified as index of selected item. */ set defaultValue(value: number); /** * Gets or sets a value indicating whether the combo box includes an editable text box as well * as a drop-down list. */ get editable(): boolean; /** * Gets or sets a value indicating whether the combo box includes an editable text box as well * as a drop-down list. */ set editable(value: boolean); }