Class DropDownTreeBuilder
Inheritance
System.Object
DropDownTreeBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class DropDownTreeBuilder : ControlBuilder
Constructors
DropDownTreeBuilder()
Declaration
public DropDownTreeBuilder()
DropDownTreeBuilder(DropDownTree)
Declaration
public DropDownTreeBuilder(DropDownTree model)
Parameters
Fields
model
Declaration
public DropDownTree model
Field Value
Properties
HtmlAttr
Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
| Type |
Description |
| System.Collections.Generic.IDictionary<System.String, System.Object> |
|
ID
Declaration
public string ID { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Output
Declaration
public override TextWriter Output { get; set; }
Property Value
| Type |
Description |
| System.IO.TextWriter |
|
Overrides
Methods
ActionFailure(String)
Triggers when the data fetch request from the remote server fails.
Declaration
public DropDownTreeBuilder ActionFailure(string actionFailure)
Parameters
| Type |
Name |
Description |
| System.String |
actionFailure |
|
Returns
ActionFailureTemplate(String)
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
public DropDownTreeBuilder ActionFailureTemplate(string actionFailureTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
actionFailureTemplate |
|
Returns
AllowFiltering(Boolean)
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
public DropDownTreeBuilder AllowFiltering(bool allowFiltering = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowFiltering |
|
Returns
AllowMultiSelection(Boolean)
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
public DropDownTreeBuilder AllowMultiSelection(bool allowMultiSelection = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowMultiSelection |
|
Returns
BeforeOpen(String)
Fires when popup opens before animation.
Declaration
public DropDownTreeBuilder BeforeOpen(string beforeOpen)
Parameters
| Type |
Name |
Description |
| System.String |
beforeOpen |
|
Returns
Blur(String)
Triggers when the Dropdown Tree input element gets focus-out.
Declaration
public DropDownTreeBuilder Blur(string blur)
Parameters
| Type |
Name |
Description |
| System.String |
blur |
|
Returns
Change(String)
Triggers when an item in a popup is selected or when the model value is changed by user.
Declaration
public DropDownTreeBuilder Change(string change)
Parameters
| Type |
Name |
Description |
| System.String |
change |
|
Returns
ChangeOnBlur(Boolean)
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
public DropDownTreeBuilder ChangeOnBlur(bool changeOnBlur = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
changeOnBlur |
|
Returns
Close(String)
Fires when popup close after animation completion.
Declaration
public DropDownTreeBuilder Close(string close)
Parameters
| Type |
Name |
Description |
| System.String |
close |
|
Returns
Created(String)
Triggers when the Dropdown Tree is created successfully.
Declaration
public DropDownTreeBuilder Created(string created)
Parameters
| Type |
Name |
Description |
| System.String |
created |
|
Returns
CssClass(String)
Specifies the CSS classes to be added with the root and popup element of the Dropdown Tree component.
that allows customization of appearance.
Declaration
public DropDownTreeBuilder CssClass(string cssClass)
Parameters
| Type |
Name |
Description |
| System.String |
cssClass |
|
Returns
CustomTemplate(String)
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
public DropDownTreeBuilder CustomTemplate(string customTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
customTemplate |
|
Returns
DataBound(String)
Triggers when data source is populated in the Dropdown Tree.
Declaration
public DropDownTreeBuilder DataBound(string dataBound)
Parameters
| Type |
Name |
Description |
| System.String |
dataBound |
|
Returns
DelimiterChar(String)
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
public DropDownTreeBuilder DelimiterChar(string delimiterChar)
Parameters
| Type |
Name |
Description |
| System.String |
delimiterChar |
|
Returns
Destroyed(String)
Triggers when the Dropdown Tree is destroyed successfully.
Declaration
public DropDownTreeBuilder Destroyed(string destroyed)
Parameters
| Type |
Name |
Description |
| System.String |
destroyed |
|
Returns
Enabled(Boolean)
Specifies a value that indicates whether the Dropdown Tree component is enabled or not.
Declaration
public DropDownTreeBuilder Enabled(bool enabled = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enabled |
|
Returns
EnableHtmlSanitizer(Boolean)
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
public DropDownTreeBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableHtmlSanitizer |
|
Returns
EnablePersistence(Boolean)
Enable or disable persisting component's state between page reloads.
Declaration
public DropDownTreeBuilder EnablePersistence(bool enablePersistence = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enablePersistence |
|
Returns
EnableRtl(Boolean)
Enable or disable rendering component in right to left direction.
Declaration
public DropDownTreeBuilder EnableRtl(bool enableRtl = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableRtl |
|
Returns
Fields(DropDownTreeFields)
Specifies the data source and mapping fields to render Dropdown Tree items.
Declaration
public DropDownTreeBuilder Fields(DropDownTreeFields fields)
Parameters
Returns
Fields(Action<DropDownTreeFieldsBuilder>)
Declaration
public DropDownTreeBuilder Fields(Action<DropDownTreeFieldsBuilder> fields)
Parameters
Returns
FilterBarPlaceholder(String)
Accepts the value to be displayed as a watermark text on the filter bar.
Declaration
public DropDownTreeBuilder FilterBarPlaceholder(string filterBarPlaceholder)
Parameters
| Type |
Name |
Description |
| System.String |
filterBarPlaceholder |
|
Returns
Filtering(String)
Triggers on typing a character in the filter bar when the allowFiltering is enabled.
Declaration
public DropDownTreeBuilder Filtering(string filtering)
Parameters
| Type |
Name |
Description |
| System.String |
filtering |
|
Returns
FilterType(TreeFilterType)
Determines on which filter type, the component needs to be considered on search action.
The TreeFilterType and its supported data types are,
Declaration
public DropDownTreeBuilder FilterType(TreeFilterType filterType)
Parameters
Returns
FloatLabelType(Object)
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
public DropDownTreeBuilder FloatLabelType(object floatLabelType)
Parameters
| Type |
Name |
Description |
| System.Object |
floatLabelType |
|
Returns
Focus(String)
Triggers when the Dropdown Tree input element is focused.
Declaration
public DropDownTreeBuilder Focus(string focus)
Parameters
| Type |
Name |
Description |
| System.String |
focus |
|
Returns
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
public DropDownTreeBuilder FooterTemplate(string footerTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
footerTemplate |
|
Returns
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
public DropDownTreeBuilder HeaderTemplate(string headerTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
headerTemplate |
|
Returns
HtmlAttributes(Object)
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
public DropDownTreeBuilder HtmlAttributes(object htmlAttributes)
Parameters
| Type |
Name |
Description |
| System.Object |
htmlAttributes |
|
Returns
IgnoreAccent(Boolean)
When ignoreAccent is set to true, then it ignores the diacritic characters or accents when filtering.
Declaration
public DropDownTreeBuilder IgnoreAccent(bool ignoreAccent = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
ignoreAccent |
|
Returns
IgnoreCase(Boolean)
When set to false, consider the case-sensitive on performing the search to find suggestions. By default, consider the casing.
Declaration
public DropDownTreeBuilder IgnoreCase(bool ignoreCase = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
ignoreCase |
|
Returns
ItemTemplate(String)
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
public DropDownTreeBuilder ItemTemplate(string itemTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
itemTemplate |
|
Returns
KeyPress(String)
Triggers when key press is successful. It helps to customize the operations at key press.
Declaration
public DropDownTreeBuilder KeyPress(string keyPress)
Parameters
| Type |
Name |
Description |
| System.String |
keyPress |
|
Returns
Locale(String)
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public DropDownTreeBuilder Locale(string locale)
Parameters
| Type |
Name |
Description |
| System.String |
locale |
|
Returns
Mode(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
public DropDownTreeBuilder Mode(Mode mode)
Parameters
| Type |
Name |
Description |
| Mode |
mode |
|
Returns
NoRecordsTemplate(String)
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
public DropDownTreeBuilder NoRecordsTemplate(string noRecordsTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
noRecordsTemplate |
|
Returns
Open(String)
Fires when popup opens after animation completion.
Declaration
public DropDownTreeBuilder Open(string open)
Parameters
| Type |
Name |
Description |
| System.String |
open |
|
Returns
Placeholder(String)
Specifies a short hint that describes the expected value of the Dropdown Tree component.
Declaration
public DropDownTreeBuilder Placeholder(string placeholder)
Parameters
| Type |
Name |
Description |
| System.String |
placeholder |
|
Returns
Specifies the height of the pop-up list.
Declaration
public DropDownTreeBuilder PopupHeight(double popupHeight)
Parameters
| Type |
Name |
Description |
| System.Double |
popupHeight |
|
Returns
Specifies the height of the pop-up list.
Declaration
public DropDownTreeBuilder PopupHeight(string popupHeight)
Parameters
| Type |
Name |
Description |
| System.String |
popupHeight |
|
Returns
Specifies the width of the popup list. By default, the popup width sets based on the width of the Dropdown Tree element.
Declaration
public DropDownTreeBuilder PopupWidth(double popupWidth)
Parameters
| Type |
Name |
Description |
| System.Double |
popupWidth |
|
Returns
Specifies the width of the popup list. By default, the popup width sets based on the width of the Dropdown Tree element.
Declaration
public DropDownTreeBuilder PopupWidth(string popupWidth)
Parameters
| Type |
Name |
Description |
| System.String |
popupWidth |
|
Returns
Readonly(Boolean)
Declaration
public DropDownTreeBuilder Readonly(bool readOnly = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
readOnly |
|
Returns
Render()
Declaration
public HtmlString Render()
Returns
| Type |
Description |
| Microsoft.AspNetCore.Html.HtmlString |
|
Select(String)
Triggers when an item in the popup is selected by the user either with mouse/tap or with keyboard navigation.
Declaration
public DropDownTreeBuilder Select(string select)
Parameters
| Type |
Name |
Description |
| System.String |
select |
|
Returns
SelectAllText(String)
Specifies the display text for the selectAll checkbox in the pop-up.
Declaration
public DropDownTreeBuilder SelectAllText(string selectAllText)
Parameters
| Type |
Name |
Description |
| System.String |
selectAllText |
|
Returns
ShowCheckBox(Boolean)
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
public DropDownTreeBuilder ShowCheckBox(bool showCheckBox = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showCheckBox |
|
Returns
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
public DropDownTreeBuilder ShowClearButton(bool showClearButton = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showClearButton |
|
Returns
ShowDropDownIcon(Boolean)
Specifies whether to show or hide the Dropdown button.
Declaration
public DropDownTreeBuilder ShowDropDownIcon(bool showDropDownIcon = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showDropDownIcon |
|
Returns
ShowSelectAll(Boolean)
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
public DropDownTreeBuilder ShowSelectAll(bool showSelectAll = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showSelectAll |
|
Returns
SortOrder(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
public DropDownTreeBuilder SortOrder(SortOrder sortOrder)
Parameters
Returns
Text(String)
Gets or sets the display text of the selected item which maps the data text field in the component.
Declaration
public DropDownTreeBuilder Text(string text)
Parameters
| Type |
Name |
Description |
| System.String |
text |
|
Returns
TreeSettings(DropDownTreeTreeSettings)
Configures the pop-up tree settings.
Declaration
public DropDownTreeBuilder TreeSettings(DropDownTreeTreeSettings treeSettings)
Parameters
Returns
TreeSettings(Action<DropDownTreeTreeSettingsBuilder>)
Declaration
public DropDownTreeBuilder TreeSettings(Action<DropDownTreeTreeSettingsBuilder> treeSettings)
Parameters
Returns
UnSelectAllText(String)
Specifies the display text for the unselect all checkbox in the pop-up.
Declaration
public DropDownTreeBuilder UnSelectAllText(string unSelectAllText)
Parameters
| Type |
Name |
Description |
| System.String |
unSelectAllText |
|
Returns
Value(Object)
Gets or sets the value of selected item(s) which maps the data value field in the component.
Declaration
public DropDownTreeBuilder Value(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Width(Double)
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
public DropDownTreeBuilder Width(double width)
Parameters
| Type |
Name |
Description |
| System.Double |
width |
|
Returns
Width(String)
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
public DropDownTreeBuilder Width(string width)
Parameters
| Type |
Name |
Description |
| System.String |
width |
|
Returns
WrapText(Boolean)
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
public DropDownTreeBuilder WrapText(bool wrapText = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
wrapText |
|
Returns
ZIndex(Double)
Specifies the z-index value of the pop-up element.
Declaration
public DropDownTreeBuilder ZIndex(double zIndex)
Parameters
| Type |
Name |
Description |
| System.Double |
zIndex |
|
Returns
