New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RadDropDownTree

Class

This Class defines the RadDropDownList.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

[EmbeddedSkin("DropDownTree", typeof(RadDropDownTree))]
[EmbeddedSkin("DropDownTree", "Default", typeof(RadDropDownTree))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadDropDownTree))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadButton))]
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(DropDown))]
[RequiredScript(typeof(TouchScrollExtender))]
[RequiredScript(typeof(MaterialRipple))]
[ClientScriptResource("Telerik.Web.UI.RadDropDownTree", "Telerik.Web.UI.DropDownTree.RadDropDownTreeScripts.js")]
[ValidationProperty("SelectedText")]
[TelerikToolboxCategory("Data")]
[ToolboxBitmap(typeof(RadDropDownTree), "Toolbox.Icons.DropDownTree.png")]
public class RadDropDownTree : RadDataBoundControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, IPostBackEventHandler, INamingContainer

Inheritance: objectControlWebControlBaseDataBoundControlDataBoundControlRadDataBoundControlRadDropDownTree...

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIFeatureGroupINamingContainerIParserAccessorIPostBackDataHandlerIPostBackEventHandlerIScriptControlISkinnableControlIUrlResolutionService...

Constructors

RadDropDownTree()

public RadDropDownTree()

Properties

AriaLabel

string

public string AriaLabel { get; set; }

AutoPostBack

bool

Gets or sets a value indicating whether a postback to the server automatically occurs when the user changes the RadDropDownTree selection.

[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_autoPostback")]
public bool AutoPostBack { get; set; }

ButtonSettings

DropDownTreeButtonSettings

Used to customize the appearance of the buttons displayed by RadDropDownTree.

[PersistenceMode(PersistenceMode.InnerProperty)]
public DropDownTreeButtonSettings ButtonSettings { get; }

CheckBoxes

DropDownTreeCheckBoxes

Get or sets the CheckBox state of the RadDropDownTree.

[ClientControlProperty]
[ClientPropertyName("_checkBoxes")]
public virtual DropDownTreeCheckBoxes CheckBoxes { get; set; }

CheckChildNodes

bool

Gets or sets a value indicating whether checking (unchecking) a node will check (uncheck) its child nodes.

[Bindable(false)]
public bool CheckChildNodes { get; set; }

CheckNodeOnClick

bool

Gets or sets a value indicating whether the DropDownNodes expands on single click.

[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_checkNodeOnClick")]
public bool CheckNodeOnClick { get; set; }

Children

DropDownTreeEntryCollection

protected DropDownTreeEntryCollection Children { get; }

ClientNodeTemplate

string

Gets or sets the HTML template of a DropDownNode when added on the client.

[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
public virtual string ClientNodeTemplate { get; set; }

CollapseAnimation

AnimationSettings

Gets the settings for the animation played when the dropdown closes.

[PersistenceMode(PersistenceMode.InnerProperty)]
public AnimationSettings CollapseAnimation { get; }

Property Value:

An AnimationSettings that represents the collapse animation.

Use the CollapseAnimation property to customize the expand animation of RadDropDownTree. You can specify the Type and Duration. To disable collapse animation effects you should set the Type to AnimationType.None.
To customize the expand animation you can use the ExpandAnimation property.

Example:

cs-api-definition
void Page_Load(object sender, EventArgs e)
{
RadDropDownTree1.CollapseAnimation.Type = AnimationType.Linear;
RadDropDownTree1.CollapseAnimation.Duration = 300;
}
cs-api-definition.skip-repl
Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
RadDropDownTree1.CollapseAnimation.Type = AnimationType.Linear
RadDropDownTree1.CollapseAnimation.Duration = 300
End Sub

Controls

ControlCollection

Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.

public override ControlCollection Controls { get; }

Property Value:

The collection of child controls for the specified server control.

Overrides: Control.Controls

CssClassFormatString

string

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

protected override string CssClassFormatString { get; }

Overrides: RadDataBoundControl.CssClassFormatString

Example:

protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

Culture

CultureInfo

Gets or sets the selected culture. Localization strings will be loaded based on this value.

public CultureInfo Culture { get; set; }

Property Value:

The culture.

DataBindings

List<DropDownNodeBinding>

Gets the settings the data binding setting for the RadDropDownTree.

[PersistenceMode(PersistenceMode.InnerProperty)]
public List<DropDownNodeBinding> DataBindings { get; set; }

The following property is used in WebService scenarios.

DataFieldID

string

Gets or sets the data field holding the unique identifier for a DropDownTreeNode.

public string DataFieldID { get; set; }

DataFieldParentID

string

Gets or sets the data field holding the ID of the parent DropDownTreeNode.

public string DataFieldParentID { get; set; }

DataTextField

string

Gets or sets the data field holding the Text property for the currently bound DropDownTreeNode.

public string DataTextField { get; set; }

DataValueField

string

Gets or sets the data field holding the Value property for the currently bound DropDownTreeNode.

public string DataValueField { get; set; }

DefaultMessage

string

Gets or sets a value indicating what message will be displayed then the control is empty (no entries selected).

[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_defaultMessage")]
public virtual string DefaultMessage { get; set; }

DefaultValue

string

Gets or sets the default value of the control used for validation.

[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_defaultValue")]
public string DefaultValue { get; set; }

DropDownNodeTemplate

ITemplate

Gets or sets the template for displaying all DropDownTreeNode in the current tree.

[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
[Bindable(false)]
[TemplateContainer(typeof(RadTreeNode))]
public virtual ITemplate DropDownNodeTemplate { get; set; }

Property Value:

An object implementing the ITemplate interface. The default value is a null reference (Nothing in Visual Basic), which indicates that this property is not set.

DropDownSettings

Gets the DropDown settings.

[PersistenceMode(PersistenceMode.InnerProperty)]
public DropDownSettings DropDownSettings { get; }

EmbeddedTree

RadTreeView

Gets a reference to the embedded tree

public RadTreeView EmbeddedTree { get; }

RadTreeView control is integrated in the RadDropDownTree.

EnableAriaSupport

bool

When set to true enables support for WAI-ARIA

[ClientControlProperty]
[ClientPropertyName("_enableAriaSupport")]
public bool EnableAriaSupport { get; set; }

EnableDirectionDetection

bool

Determines whether the Direction Detection is enabled or not.

[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_enableDirectionDetection")]
public bool EnableDirectionDetection { get; set; }

EnableEntryTextHtmlEncoding

bool

Gets or sets a value indicating whether RadDropDownTree should HTML encode the text of the entries.

[ClientControlProperty]
[ClientPropertyName("_enableEntryTextHtmlEncoding")]
public bool EnableEntryTextHtmlEncoding { get; set; }

Property Value:

true if the text should be encoded; otherwise, false. The default value is false.

EnableFiltering

bool

Gets or sets a value indicating whether the control filtering is enabled.

[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_enableFiltering")]
public bool EnableFiltering { get; set; }

EnableScreenBoundaryDetection

bool

Determines whether the Screen Boundaries Detection is enabled or not.

[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_enableScreenBoundaryDetection")]
public bool EnableScreenBoundaryDetection { get; set; }

Entries

DropDownTreeEntryCollection

Gets the RadDropDownTree entries collection.

[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public DropDownTreeEntryCollection Entries { get; }

EntriesDelimiter

string

Gets or sets a value indicating the delimiter between entries.

[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_entriesDelimiter")]
public string EntriesDelimiter { get; set; }

ExpandAnimation

AnimationSettings

Gets the settings for the animation played when the dropdown opens.

[PersistenceMode(PersistenceMode.InnerProperty)]
public AnimationSettings ExpandAnimation { get; }

Property Value:

An AnimationSettings that represents the expand animation.

Use the ExpandAnimation property to customize the expand animation of RadDropDownTree. You can specify the Type and Duration. To disable expand animation effects you should set the Type to AnimationType.None.
To customize the collapse animation you can use the CollapseAnimation property.

Example:

cs-api-definition
void Page_Load(object sender, EventArgs e)
{
RadDropDownTree1.ExpandAnimation.Type = AnimationType.Linear;
RadDropDownTree1.ExpandAnimation.Duration = 300;
}
cs-api-definition.skip-repl
Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
RadDropDownTree1.ExpandAnimation.Type = AnimationType.Linear
RadDropDownTree1.ExpandAnimation.Duration = 300
End Sub

ExpandNodeOnSingleClick

bool

Gets or sets a value indicating whether the DropDownNodes expands on single click.

[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_expandNodeOnSingleClick")]
public bool ExpandNodeOnSingleClick { get; set; }

FilterSettings

DropDownTreeFilterSettings

Used to customize filtering of the RadDropDownTree.

[PersistenceMode(PersistenceMode.InnerProperty)]
public DropDownTreeFilterSettings FilterSettings { get; }

Footer

WebControl

Get a footer of RadDropDownTree.

[Browsable(false)]
public WebControl Footer { get; }

FooterTemplate

ITemplate

Gets or sets the ITemplate that defines the RadDropDownTree footer template.

[TemplateContainer(typeof(RadDropDownTree))]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
[Bindable(false)]
public virtual ITemplate FooterTemplate { get; set; }

Property Value:

The footer template.

FullPathDelimiter

string

Gets or sets a value indicating the delimiter in FullPath text mode.

[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_fullPathDelimiter")]
public string FullPathDelimiter { get; set; }

Header

WebControl

Get a header of RadDropDownTree.

[Browsable(false)]
public WebControl Header { get; }

HeaderTemplate

ITemplate

Gets or sets the ITemplate that defines the RadDropDownTree header template.

[TemplateContainer(typeof(RadDropDownTree))]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
[Bindable(false)]
public virtual ITemplate HeaderTemplate { get; set; }

Property Value:

The header template.

Localization

DropDownTreeButtons

Gets the localization.

[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
public DropDownTreeButtons Localization { get; }

Property Value:

The localization.

LocalizationPath

string

Gets or sets a value indicating where RadDropDownTree will look for its .resx localization files.

public string LocalizationPath { get; set; }

Property Value:

The localization path.

ODataDataSourceID

string

Gets or sets the ODataDataSource used for data binding.

public override string ODataDataSourceID { get; set; }

Overrides: RadDataBoundControl.ODataDataSourceID

OnClientClearButtonClicked

string

Gets or sets the name of the JavaScript function called on clear button clicked

[ClientControlEvent]
[ClientPropertyName("clearButtonClicked")]
public string OnClientClearButtonClicked { get; set; }

OnClientClearButtonClicking

string

Gets or sets the name of the JavaScript function called on clear button clicking

[ClientControlEvent]
[ClientPropertyName("clearButtonClicking")]
public string OnClientClearButtonClicking { get; set; }

OnClientDropDownClosed

string

The client-side event that is fired after the dropdown of the DropDownTree is closed.

[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("dropDownClosed")]
public string OnClientDropDownClosed { get; set; }

The event handler receives two parameter: the instance of the DropDownTree client-side object and event args. The event can not be cancelled

Example:

&lt;script language="javascript"&gt;

function HandleClose(sender, args)
{
alert("Closed dropdown");

}

&lt;/script&gt;


&lt;telerik:RadDropDownTree
id="RadDropDownTree1"
Runat="server"
OnClientDropDownClosed="HandleClose"&gt;
&lt;/telerik:RadDropDownTree&gt;

OnClientDropDownClosing

string

The client-side event that is fired before the dropdown of the DropDownTree is closed.

[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("dropDownClosing")]
public string OnClientDropDownClosing { get; set; }

The event handler receives two parameter: the instance of the DropDownTree client-side object and event args. The event can be cancelled - simply set args.set_cancel to true args.set_cancel(true); from the event handler and the DropDownTree dropdown will not be closed.

Example:

&lt;script language="javascript"&gt;

function HandleClose(sender, args)
{
if (someCondition)
{
args.set_cancel(true);
}
else
{
alert("Closing dropdown");
}
}

&lt;/script&gt;


&lt;telerik:RadDropDownTree
id="RadDropDownTree1"
Runat="server"
OnClientDropDownClosing="HandleClose"&gt;
&lt;/telerik:RadDropDownTree&gt;

OnClientDropDownOpened

string

The client-side event that is fired after the dropdown of the DropDownTree is opened.

[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("dropDownOpened")]
public string OnClientDropDownOpened { get; set; }

The event handler receives two parameter: the instance of the DropDownTree client-side object and event args. The event cannot be cancelled.

Example:

&lt;script language="javascript"&gt;

function HandleOpen(sender,args)
{
alert("Opening combobox with " + comboBox.get_items().get_count() + " items");

}

&lt;/script&gt;


&lt;telerik:RadDropDownTree
id="RadDropDownTree1"
Runat="server"
OnClientDropDownOpened="HandleOpen"&gt;
&lt;/telerik:RadDropDownTree&gt;

OnClientDropDownOpening

string

The client-side event that is fired before the dropdown of the DropDownTree is opened.

[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("dropDownOpening")]
public string OnClientDropDownOpening { get; set; }

The event handler receives two parameter: the instance of the DropDownTree client-side object and event args. The event can be cancelled - simply set args.set_cancel to true args.set_cancel(true); from the event handler and the DropDownTree dropdown will not be opened.

Example:

&lt;script language="javascript"&gt;

function HandleOpen(sender,args)
{
if (someCondition)
{
args.set_cancel(true);
}
else
{
alert("Opening dropDown");
}
}

&lt;/script&gt;


&lt;telerik:RadDropDownTree
id="RadDropDownTree1"
Runat="server"
OnClientDropDownOpening="HandleOpen"&gt;
&lt;/telerik:RadDropDownTree&gt;

OnClientEntryAdded

string

Gets or sets the name of the JavaScript function called after an entry has been added

[ClientControlEvent]
[ClientPropertyName("entryAdded")]
public string OnClientEntryAdded { get; set; }

OnClientEntryAdding

string

Gets or sets the name of the JavaScript function called when an entry is about to be added

[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("entryAdding")]
public string OnClientEntryAdding { get; set; }

Example:

function onClientEntryAdding(sender, args)
{
args.set_cancel(true);
}

OnClientEntryRemoved

string

Gets or sets the name of the JavaScript function called after an entry has been removed

[ClientControlEvent]
[ClientPropertyName("entryRemoved")]
public string OnClientEntryRemoved { get; set; }

OnClientEntryRemoving

string

Gets or sets the name of the JavaScript function called when an entry is about to be removed

[ClientControlEvent]
[ClientPropertyName("entryRemoving")]
public string OnClientEntryRemoving { get; set; }

Example:

function onClientEntryRemoving(sender, args)
{
args.set_cancel(true);
}

OnClientLoad

string

Gets or sets a value indicating the client-side event handler that is called after the RadDropDownTree client-side object is initialized.

[ClientControlEvent]
[ClientPropertyName("load")]
public string OnClientLoad { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClienLoad client-side event handler is called after the DropDownTree is fully initialized on the client.

A single parameter - the dropdowntree client object - is passed to the handler.

This event cannot be cancelled.

Example:

<p>&lt;script type="text/javascript"&gt;<br />
function onClientLoadHandler(sender)<br />
{<br />
       alert(sender.get_id());<br />
}<br />
&lt;/script&gt;</p>
<p>&lt;telerik:RadDropDownTree ID="RadDropDownTree1"<br />
runat= "server"<br />
    <strong>OnClientLoad="onClientLoadHandler"</strong>&gt;<br />
....<br />
&lt;/telerik:RadDropDownTree&gt;</p>

SelectedText

string

Gets the entries text with the appropriate delimiter.

[Browsable(false)]
[Bindable(true, BindingDirection.TwoWay)]
[Themeable(false)]
public string SelectedText { get; set; }

SelectedValue

string

Gets the entries values in comma separated list.

[Browsable(false)]
[Bindable(true, BindingDirection.TwoWay)]
[Themeable(false)]
public string SelectedValue { get; set; }

SupportsRenderingMode

bool

protected override bool SupportsRenderingMode { get; }

Overrides: RadDataBoundControl.SupportsRenderingMode

TagKey

HtmlTextWriterTag

protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

TextMode

DropDownTreeTextMode

Gets or sets a value indicating whether the entry should show the its full path in the entry area.

[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_textMode")]
public DropDownTreeTextMode TextMode { get; set; }

UniqueID

string

Gets the unique, hierarchically qualified identifier for the server control.

[ClientControlProperty]
[ClientPropertyName("_uniqueId")]
public override string UniqueID { get; }

Property Value:

The fully qualified identifier for the server control.

Overrides: Control.UniqueID

WebServiceSettings

Gets the settings for the web service used to populate nodes when ExpandMode set to WebService.

[PersistenceMode(PersistenceMode.InnerProperty)]
public WebServiceSettings WebServiceSettings { get; }

Methods

AddAttributesToRender(HtmlTextWriter)

protected override void AddAttributesToRender(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadDataBoundControl.AddAttributesToRender(HtmlTextWriter)

CreateChildControls()

protected override void CreateChildControls()

Overrides: Control.CreateChildControls()

CreateChildItemCollection()

protected DropDownTreeEntryCollection CreateChildItemCollection()

Returns:

DropDownTreeEntryCollection

CreateControlRenderer()

protected override IRenderer CreateControlRenderer()

Returns:

IRenderer

Overrides: RadDataBoundControl.CreateControlRenderer()

CreateControlRenderer<T>()

protected virtual void CreateControlRenderer<T>()

DataBind()

Bind the RadDropDownTree control.

public override void DataBind()

Overrides: BaseDataBoundControl.DataBind()

DescribeComponent(IScriptDescriptor)

protected override void DescribeComponent(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadDataBoundControl.DescribeComponent(IScriptDescriptor)

ExpandAllDropDownNodes()

Expands all of the DropDownNodes.

public void ExpandAllDropDownNodes()

FindEntryByTextAndValue(string, string)

protected DropDownTreeEntry FindEntryByTextAndValue(string text, string value)

Parameters:textstringvaluestringReturns:

DropDownTreeEntry

LoadPostData(string, NameValueCollection)

Executed when post data is loaded from the request

protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)

Parameters:postDataKeystringpostCollectionNameValueCollectionReturns:

bool

Overrides: RadDataBoundControl.LoadPostData(string, NameValueCollection)

LoadViewState(object)

protected override void LoadViewState(object savedState)

Parameters:savedStateobject

Overrides: DataBoundControl.LoadViewState(object)

OnEntriesAdded(DropDownTreeEntriesEventArgs)

protected virtual void OnEntriesAdded(DropDownTreeEntriesEventArgs e)

Parameters:eDropDownTreeEntriesEventArgs

OnEntriesRemoved(DropDownTreeEntriesEventArgs)

protected virtual void OnEntriesRemoved(DropDownTreeEntriesEventArgs e)

Parameters:eDropDownTreeEntriesEventArgs

OnEntryAdded(DropDownTreeEntryEventArgs)

protected virtual void OnEntryAdded(DropDownTreeEntryEventArgs e)

Parameters:eDropDownTreeEntryEventArgs

OnEntryRemoved(DropDownTreeEntryEventArgs)

protected virtual void OnEntryRemoved(DropDownTreeEntryEventArgs e)

Parameters:eDropDownTreeEntryEventArgs

OnInit(EventArgs)

protected override void OnInit(EventArgs e)

Parameters:eEventArgs

Overrides: RadDataBoundControl.OnInit(EventArgs)

OnNodeDataBound(DropDownTreeNodeDataBoundEventArguments)

protected virtual void OnNodeDataBound(DropDownTreeNodeDataBoundEventArguments e)

Parameters:eDropDownTreeNodeDataBoundEventArguments

OnPreRender(EventArgs)

protected override void OnPreRender(EventArgs e)

Parameters:eEventArgs

Overrides: RadDataBoundControl.OnPreRender(EventArgs)

RaisePostBackEvent(string)

public void RaisePostBackEvent(string eventArgument)

Parameters:eventArgumentstring

Implements: IPostBackEventHandler.RaisePostBackEvent(string)

RenderContents(HtmlTextWriter)

protected override void RenderContents(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadDataBoundControl.RenderContents(HtmlTextWriter)

SaveViewState()

protected override object SaveViewState()

Returns:

object

Overrides: DataBoundControl.SaveViewState()

SyncEmbeddedTree()

Synchronize the nodes and the entries collection.

public void SyncEmbeddedTree()

The method is used in cases when some nodes are checked manually.

TrackViewState()

protected override void TrackViewState()

Overrides: DataBoundControl.TrackViewState()

Events

EntriesAdded

DropDownTreeEntriesEventHandler

Occurs after entires are added

public event DropDownTreeEntriesEventHandler EntriesAdded

EntriesRemoved

DropDownTreeEntriesEventHandler

Occurs after entires are removed

public event DropDownTreeEntriesEventHandler EntriesRemoved

EntryAdded

DropDownTreeEntryEventHandler

Occurs when an entry is added

public event DropDownTreeEntryEventHandler EntryAdded

EntryRemoved

DropDownTreeEntryEventHandler

Occurs when an entry is removed

public event DropDownTreeEntryEventHandler EntryRemoved

NodeDataBound

DropDownTreeNodeDataBoundEventHandler

public event DropDownTreeNodeDataBoundEventHandler NodeDataBound