Class DropDownTree

Inheritance
System.Object
TagHelper
EJTagHelper
DropDownTree
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.EJ2.DropDowns
Assembly: Syncfusion.EJ2.dll
Syntax
public class DropDownTree : EJTagHelper

Constructors

DropDownTree()

Declaration
public DropDownTree()

Properties

ActionFailure

Triggers when the data fetch request from the remote server fails.

Declaration
[HtmlAttributeName("actionFailure")]
public string ActionFailure { get; set; }
Property Value
Type Description
System.String

ActionFailureTemplate

Specifies the template that renders to the popup list content of the Dropdown Tree component when the data fetch request from the remote server fails.

Declaration
[HtmlAttributeName("actionFailureTemplate")]
public string ActionFailureTemplate { get; set; }
Property Value
Type Description
System.String

AllowFiltering

When allowFiltering is set to true, it shows the filter bar (search text box) of the component. The filter action retrieves matched items through the filtering event based on the characters typed in the search text box. If no match is found, the value of the noRecordsTemplate property will be displayed.

Declaration
[HtmlAttributeName("allowFiltering")]
public bool AllowFiltering { get; set; }
Property Value
Type Description
System.Boolean

AllowMultiSelection

Enables or disables the multi-selection of items. To select multiple items: Select the items by holding down the CTRL key when clicking on the items. Select consecutive items by clicking the first item to select and hold down the SHIFT key and click the last item to select.

Declaration
[HtmlAttributeName("allowMultiSelection")]
public bool AllowMultiSelection { get; set; }
Property Value
Type Description
System.Boolean

BeforeOpen

Fires when popup opens before animation.

Declaration
[HtmlAttributeName("beforeOpen")]
public string BeforeOpen { get; set; }
Property Value
Type Description
System.String

Blur

Triggers when the Dropdown Tree input element gets focus-out.

Declaration
[HtmlAttributeName("blur")]
public string Blur { get; set; }
Property Value
Type Description
System.String

Change

Triggers when an item in a popup is selected or when the model value is changed by user.

Declaration
[HtmlAttributeName("change")]
public string Change { get; set; }
Property Value
Type Description
System.String

ChangeOnBlur

By default, the Dropdown Tree component fires the change event while focusing out the component. If you want to fire the change event on every value selection and remove, then disable this property.

Declaration
[HtmlAttributeName("changeOnBlur")]
public bool ChangeOnBlur { get; set; }
Property Value
Type Description
System.Boolean

ClassName

Declaration
protected override string ClassName { get; }
Property Value
Type Description
System.String
Overrides

Close

Fires when popup close after animation completion.

Declaration
[HtmlAttributeName("close")]
public string Close { get; set; }
Property Value
Type Description
System.String

Created

Triggers when the Dropdown Tree is created successfully.

Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
Type Description
System.String

CssClass

Specifies the CSS classes to be added with the root and popup element of the Dropdown Tree component. that allows customization of appearance.

Declaration
[HtmlAttributeName("cssClass")]
public string CssClass { get; set; }
Property Value
Type Description
System.String

CustomTemplate

This property is used to customize the display text of the selected items in the Dropdown Tree. The given custom template is added to the input instead of the selected item text in the Dropdown Tree when the multi-selection or checkbox support is enabled.

Declaration
[HtmlAttributeName("customTemplate")]
public string CustomTemplate { get; set; }
Property Value
Type Description
System.String

DataBound

Triggers when data source is populated in the Dropdown Tree.

Declaration
[HtmlAttributeName("dataBound")]
public string DataBound { get; set; }
Property Value
Type Description
System.String

DelimiterChar

Defines the value separator character in the input element when multi-selection or checkbox is enabled in the Dropdown Tree. The delimiter character is applicable only for default and delimiter visibility modes.

Declaration
[HtmlAttributeName("delimiterChar")]
public string DelimiterChar { get; set; }
Property Value
Type Description
System.String

Destroyed

Triggers when the Dropdown Tree is destroyed successfully.

Declaration
[HtmlAttributeName("destroyed")]
public string Destroyed { get; set; }
Property Value
Type Description
System.String

Enabled

Specifies a value that indicates whether the Dropdown Tree component is enabled or not.

Declaration
[HtmlAttributeName("enabled")]
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

EnableHtmlSanitizer

Specifies whether to allow rendering of untrusted HTML values in the Dropdown Tree component. While enable this property, it sanitize suspected untrusted strings and script, and update in the Dropdown Tree component.

Declaration
[HtmlAttributeName("enableHtmlSanitizer")]
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration
[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

Fields

Specifies the data source and mapping fields to render Dropdown Tree items.

Declaration
[HtmlAttributeName("fields")]
public DropDownTreeFields Fields { get; set; }
Property Value
Type Description
DropDownTreeFields

FilterBarPlaceholder

Accepts the value to be displayed as a watermark text on the filter bar.

Declaration
[HtmlAttributeName("filterBarPlaceholder")]
public string FilterBarPlaceholder { get; set; }
Property Value
Type Description
System.String

Filtering

Triggers on typing a character in the filter bar when the allowFiltering is enabled.

Declaration
[HtmlAttributeName("filtering")]
public string Filtering { get; set; }
Property Value
Type Description
System.String

FilterType

Determines on which filter type, the component needs to be considered on search action. The TreeFilterType and its supported data types are,

Declaration
[HtmlAttributeName("filterType")]
public TreeFilterType FilterType { get; set; }
Property Value
Type Description
TreeFilterType

FloatLabelType

Specifies whether to display the floating label above the input element. Possible values are: Never: The label will never float in the input when the placeholder is available. Always: The floating label will always float above the input. Auto: The floating label will float above the input after focusing or entering a value in the input.

Declaration
[HtmlAttributeName("floatLabelType")]
public object FloatLabelType { get; set; }
Property Value
Type Description
System.Object

Focus

Triggers when the Dropdown Tree input element is focused.

Declaration
[HtmlAttributeName("focus")]
public string Focus { get; set; }
Property Value
Type Description
System.String

FooterTemplate

Specifies the template that renders a customized footer container at the bottom of the pop-up list. By default, the footerTemplate will be null and there will be no footer container for the pop-up list.

Declaration
[HtmlAttributeName("footerTemplate")]
public string FooterTemplate { get; set; }
Property Value
Type Description
System.String

HeaderTemplate

Specifies the template that renders a customized header container at the top of the pop-up list. By default, the headerTemplate will be null and there will be no header container for the pop-up list.

Declaration
[HtmlAttributeName("headerTemplate")]
public string HeaderTemplate { get; set; }
Property Value
Type Description
System.String

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

IgnoreAccent

When ignoreAccent is set to true, then it ignores the diacritic characters or accents when filtering.

Declaration
[HtmlAttributeName("ignoreAccent")]
public bool IgnoreAccent { get; set; }
Property Value
Type Description
System.Boolean

IgnoreCase

When set to false, consider the case-sensitive on performing the search to find suggestions. By default, consider the casing.

Declaration
[HtmlAttributeName("ignoreCase")]
public bool IgnoreCase { get; set; }
Property Value
Type Description
System.Boolean

IsFor

Declaration
protected override bool IsFor { get; }
Property Value
Type Description
System.Boolean
Overrides

ItemTemplate

Specifies a template to render customized content for all the items. If the itemTemplate property is set, the template content overrides the displayed item text. The property accepts template string or HTML element ID holding the content.

Declaration
[HtmlAttributeName("itemTemplate")]
public string ItemTemplate { get; set; }
Property Value
Type Description
System.String

KeyPress

Triggers when key press is successful. It helps to customize the operations at key press.

Declaration
[HtmlAttributeName("keyPress")]
public string KeyPress { get; set; }
Property Value
Type Description
System.String

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
[HtmlAttributeName("locale")]
public string Locale { get; set; }
Property Value
Type Description
System.String

Mode

Configures visibility mode for component interaction when allowMultiSelection or checkbox is enabled. Different modes are: Box : Selected items will be visualized in chip. Delimiter : Selected items will be visualized in the text content. Default : On focus in component will act in the box mode. On blur component will act in the delimiter mode. Custom : Selected items will be visualized with the given custom template value. The given custom template is added to the input instead of the selected item text in the Dropdown Tree when the multi-selection or checkbox support is enabled.

Declaration
[HtmlAttributeName("mode")]
public Mode Mode { get; set; }
Property Value
Type Description
Mode

NameSpace

Declaration
protected override string NameSpace { get; }
Property Value
Type Description
System.String
Overrides

NoRecordsTemplate

Specifies the template that renders a customized pop-up list content when there is no data available to be displayed within the pop-up.

Declaration
[HtmlAttributeName("noRecordsTemplate")]
public string NoRecordsTemplate { get; set; }
Property Value
Type Description
System.String

Open

Fires when popup opens after animation completion.

Declaration
[HtmlAttributeName("open")]
public string Open { get; set; }
Property Value
Type Description
System.String

Placeholder

Specifies a short hint that describes the expected value of the Dropdown Tree component.

Declaration
[HtmlAttributeName("placeholder")]
public string Placeholder { get; set; }
Property Value
Type Description
System.String

PopupHeight

Specifies the height of the pop-up list.

Declaration
[HtmlAttributeName("popupHeight")]
public string PopupHeight { get; set; }
Property Value
Type Description
System.String

PopupWidth

Specifies the width of the popup list. By default, the popup width sets based on the width of the Dropdown Tree element.

Declaration
[HtmlAttributeName("popupWidth")]
public string PopupWidth { get; set; }
Property Value
Type Description
System.String

Readonly

When set to true, the user interactions on the component will be disabled.

Declaration
[HtmlAttributeName("readonly")]
public bool Readonly { get; set; }
Property Value
Type Description
System.Boolean

Select

Triggers when an item in the popup is selected by the user either with mouse/tap or with keyboard navigation.

Declaration
[HtmlAttributeName("select")]
public string Select { get; set; }
Property Value
Type Description
System.String

SelectAllText

Specifies the display text for the selectAll checkbox in the pop-up.

Declaration
[HtmlAttributeName("selectAllText")]
public string SelectAllText { get; set; }
Property Value
Type Description
System.String

ShowCheckBox

Enables or disables the checkbox option in the Dropdown Tree component. If enabled, the Checkbox will be displayed next to the expand or collapse icon of the tree items.

Declaration
[HtmlAttributeName("showCheckBox")]
public bool ShowCheckBox { get; set; }
Property Value
Type Description
System.Boolean

ShowClearButton

Specifies whether to show or hide the clear icon in textbox. When the clear button is clicked, value, text properties will be reset to null.

Declaration
[HtmlAttributeName("showClearButton")]
public bool ShowClearButton { get; set; }
Property Value
Type Description
System.Boolean

ShowDropDownIcon

Specifies whether to show or hide the Dropdown button.

Declaration
[HtmlAttributeName("showDropDownIcon")]
public bool ShowDropDownIcon { get; set; }
Property Value
Type Description
System.Boolean

ShowSelectAll

Specifies whether to show or hide the selectAll checkbox in the pop-up which allows you to select all the items in the pop-up.

Declaration
[HtmlAttributeName("showSelectAll")]
public bool ShowSelectAll { get; set; }
Property Value
Type Description
System.Boolean

SortOrder

Specifies a value that indicates whether the items are sorted in the ascending or descending order, or not sorted at all. The available types of sort order are, None - The items are not sorted. Ascending - The items are sorted in the ascending order. Descending - The items are sorted in the descending order.

Declaration
[HtmlAttributeName("sortOrder")]
public SortOrder SortOrder { get; set; }
Property Value
Type Description
SortOrder

TagName

Declaration
protected override string TagName { get; }
Property Value
Type Description
System.String
Overrides

Text

Gets or sets the display text of the selected item which maps the data text field in the component.

Declaration
[HtmlAttributeName("text")]
public string Text { get; set; }
Property Value
Type Description
System.String

TreeSettings

Configures the pop-up tree settings.

Declaration
[HtmlAttributeName("treeSettings")]
public DropDownTreeTreeSettings TreeSettings { get; set; }
Property Value
Type Description
DropDownTreeTreeSettings

UnSelectAllText

Specifies the display text for the unselect all checkbox in the pop-up.

Declaration
[HtmlAttributeName("unSelectAllText")]
public string UnSelectAllText { get; set; }
Property Value
Type Description
System.String

Value

Gets or sets the value of selected item(s) which maps the data value field in the component.

Declaration
[HtmlAttributeName("value")]
public object Value { get; set; }
Property Value
Type Description
System.Object

Width

Specifies the width of the component. By default, the component width sets based on the width of its parent container. You can also set the width in pixel values.

Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type Description
System.String

WrapText

Defines whether to enable or disable the feature called wrap the selected items into multiple lines when the selected item's text content exceeded the input width limit.

Declaration
[HtmlAttributeName("wrapText")]
public bool WrapText { get; set; }
Property Value
Type Description
System.Boolean

ZIndex

Specifies the z-index value of the pop-up element.

Declaration
[HtmlAttributeName("zIndex")]
public double ZIndex { get; set; }
Property Value
Type Description
System.Double