DropDownTreeModel

actionFailureText String

Specifies the text to be displayed when a remote request fails.

Default: Error occurred in the request

allowFiltering Boolean

Specifies whether to allow the list of items to be filtered as input is entered into the search box.

Default: false

allowMultiSelect Boolean

Specifies whether to allow multiple items to be selected or not.

• To select multiple items randomly, hold down **Ctrl** when clicking on the items.
• To select multiple consecutive items, select the first item and then hold down **Shift** and click the last item to select.

Default: false

changeOnBlur Boolean

Specifies whether to fire the change event on every item selection or only when the control losses focus. Default, fires when focus is lost.

Default: true

clearAllText String

Specifies display text for the “Clear All” checkbox in the popup.

Default: Clear All

cssClass String

Specifies CSS classes to customize the appearance of the control.

Default: null

customTemplate Function

Specifies a template to customize the text of the selected item in the drop down input element when multi-selection or checkboxes are enabled.

Default: ${value.length} item(s) selected

delimiterChar String

Specifies the text character used to separate items in the input element when multi-selection or checkboxes are enabled.

Default: ,

enabled Boolean

Specifies whether the control is enabled or disabled, disabled will prevent user interaction.

Default: true

enableHtmlSanitizer Boolean

Specifies whether to allow the rendering of untrusted HTML and JavaScript values withing the control. When true, any untrusted strings or scripts will be remote before rendering.

Default: true

enableRtl Boolean

Specifies whether to render the control in right to left direction.

Default: false

enableState Boolean

Specifies whether to persist the state of the control between page loads.

Default: false

filterBarPlaceholder String

Specifies a placeholder for the filter search text box.

Default: null

filterType FilterType

Specifies the type of filter to be used when filter the list items.

Default: StartsWith

footerTemplate Function

Specifies a template to customize the appearance of the footer that is visible below all list items in the popup.

Default: null

headerTemplate Function

Specifies a template to customize the appearance of the header that is visible above all list items in the popup.

Default: null

htmlAttributes {:}

Specifies additional HTML attributes, such as title, styles, class, id, and name, in a key-value pair format that will be appended to the HTML element. If both the property and equivalent HTML attributes are configured, then the control overrides the property value with the HTML attributes.

Default: {}

ignoreAccent Boolean

Specifies whether to ignore diacritic characters when filtering the list items.

Default: false

ignoreCase Boolean

Specifies whether to ignore the case, make case-sensitive, when filtering the list items.

Default: true

items FieldsModel

Specifies the data source and field mappings for the items in the tree list.

Default: { }

itemTemplate Function

Specifies a template to customize how the individual list items are displayed in the popup.

Default: null

labelType FloatingLabelType

Specifies the condition on when to show the floating label, for example: never, always.

Default: Never

locale String

Specifies the culture and localization value for this control, overriding the globally defined value.

Default: en-US

mode Mode

Specifies how selected values will be displayed in the input element when multi-selection or checkboxes are enabled.

Default: Default

noRecordsText String

Specifies the text to be displayed when there are no records to be displayed.

Default: No records found

placeholder String

Specifies a short description of what is expected to be within the list of items.

Default: null

popupHeight String

Specifies the height of the popup expressed in pixels.

Default: 300px

popupWidth String

Specifies the width of the popup expressed in pixels. By default, the width of the popup is the width of the control. Value can be expressed in percent or pixels.

Default: 100%

readonly Boolean

Specifies whether the control is readonly disabling all user interaction with the control.

Default: false

selectAllText String

Specifies display text for the “Select All” checkbox in the popup.

Default: 100%

showCheckBox Boolean

Specifies whether to display checkboxes to the left of list item in the popup to allow users to select values from.

Default: false

showClearButton Boolean

Specifies whether to show the clear button or not, allowing the user to clear the current values.

Default: true

showPopupButton Boolean

Specifies whether to show the popup button or not, allowing the user to manually open the list items.

Default: true

showSelectAll Boolean

Specifies whether to show the “Select All” checkbox or not in the popup allowing all items to be selected at once.

Default: false

sortOrder SortOrder

Specifies whether to sort the list items in order or to leave the items in the order they were added.

Default: None

text String

Gets or sets the display text of the current selected list item in the control.

Default: null

treeSettings TreeSettingsModel

Specifies the tree list settings in the popup.

Default: {autoCheck: false, expandOn: 'Auto', loadOnDemand: false}

value String

Gets or sets the value of the current selected list item in the control.

Default: null

width String Number

Specifies the width of the control. By default, the width of the control is determined by its parent container. Value can be expressed in percent or pixels.

Default: 100%

wrapText Boolean

Specifies whether to warp list item text onto multiple lines where the item content exceeds the input element’s width.

Default: false

zIndex Number

Specifies the zIndex of the popup.

Default: 1000

actionFailure EmitType<Object>

Event callback that is raised when there is a failure in retrieving data from the data store.

beforeOpen EmitType<DropDownTreeBeforeOpenEventArgs>

Event callback that is raised before the popup opens.

blur EmitType<Object>

Event callback that is raised when focus leaves the control.

change EmitType<DropDownTreeChangeEventArgs>

Event callback that is raised when the value has changed, either by a user selecting a value or by the value property being changed.

close EmitType<DropDownTreePopupEventArgs>

Event callback that is raised when the popup is closed.

created EmitType<CreatedEventArgs>

Event callback that is raised when the control has been created.

dataBound EmitType<DropDownTreeDataBoundEventArgs>

Event callback that is raised when data has been bound to the control.

destroyed EmitType<Object>

Event callback that is raised when the control has been destroyed.

filtering EmitType<DropDownTreeFilteringEventArgs>

Event callback that is raised when the list of items is filtered by typing in the textbox.

focus EmitType<DropDownTreeFocusEventArgs>

Event callback that is raised when the control is focused.

keyPress EmitType<DropDownTreeKeyPressEventArgs>

Event callback that is raised when a key is pressed in the input element.

open EmitType<DropDownTreePopupEventArgs>

Event callback that is raised when the popup is opened.

select EmitType<DropDownTreeSelectEventArgs>

Event callback that is raised when an item in the popup list is selected, either by a mouse/tap event or navigating the list using the keyboard.