\Kendo\UI\DropDownTree

A PHP wrapper for Kendo UI DropDownTree.

Inherits from \Kendo\UI\Widget.

Usage

To use DropDownTree in a PHP page instantiate a new instance, configure it via the available configuration methods and output it by echo-ing the result of the render method.

Using Kendo DropDownTree

<?php
// Create a new instance of DropDownTree and specify its id
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');

// Configure it
$dropDownTree->animation(true)

// Output it

echo $dropDownTree->render();
?>

Methods

animation

Configures the opening and closing animations of the suggestion popup. Setting the animation option to false will disable the opening and closing animations. As a result, the suggestion popup will open and close instantly. is not a valid configuration.

Returns

\Kendo\UI\DropDownTree

Parameters

$value boolean |\Kendo\UI\DropDownTreeAnimation |array

Example - using boolean

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->animation(true);
?>

Example - using \Kendo\UI\DropDownTreeAnimation

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$animation = new \Kendo\UI\DropDownTreeAnimation();
$close = new \Kendo\UI\DropDownTreeAnimationClose();
$animation->close($close);
$dropDownTree->animation($animation);
?>

Example - using array

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$close = new \Kendo\UI\DropDownTreeAnimationClose();
$dropDownTree->animation(array('close' => $close));
?>

autoBind

Controls whether to bind the widget to the data source on initialization.

Returns

\Kendo\UI\DropDownTree

Parameters

$value boolean

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->autoBind(true);
?>

autoClose

Controls whether to close the popup when item is selected or checked.

Returns

\Kendo\UI\DropDownTree

Parameters

$value boolean

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->autoClose(true);
?>

autoWidth

If set to true, the widget automatically adjusts the width of the popup element and does not wrap up the item label.

Returns

\Kendo\UI\DropDownTree

Parameters

$value boolean

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->autoWidth(true);
?>

change

Fired when the value of the widget is changed by the user.The event handler function context (available via the this keyword) will be set to the widget instance. For additional information check the change event documentation.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->change('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onChange(e) {
        // handle the change event.
    }
</script>
<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->change('onChange');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->change(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

checkAll

When this options is set to true and checkboxes are enabled, a tristate checkbox appears above the embedded treeview. Clicking that checkbox will check or uncheck all the loaded enabled items of the treeview.

Returns

\Kendo\UI\DropDownTree

Parameters

$value boolean

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->checkAll(true);
?>

checkAllTemplate

The template used to render the checkAll label. By default, the widget displays only a span element with text "Check all".

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->checkAllTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->checkAllTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

checkboxes

If true or an object, renders checkboxes beside each node. In this case the widget value should be an array.

Returns

\Kendo\UI\DropDownTree

Parameters

$value boolean |\Kendo\UI\DropDownTreeCheckboxes |array

Example - using boolean

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->checkboxes(true);
?>

Example - using \Kendo\UI\DropDownTreeCheckboxes

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$checkboxes = new \Kendo\UI\DropDownTreeCheckboxes();
$checkChildren = true;
$checkboxes->checkChildren($checkChildren);
$dropDownTree->checkboxes($checkboxes);
?>

Example - using array

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$checkChildren = true;
$dropDownTree->checkboxes(array('checkChildren' => $checkChildren));
?>

clearButton

Unless this option is set to false, a button will appear when hovering the widget. Clicking that button will reset the widget's value and will trigger the change event.

Returns

\Kendo\UI\DropDownTree

Parameters

$value boolean

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->clearButton(true);
?>

close

Fired when the popup of the widget is closed.The event handler function context (available via the this keyword) will be set to the widget instance. For additional information check the close event documentation.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->close('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onClose(e) {
        // handle the close event.
    }
</script>
<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->close('onClose');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->close(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

dataBound

Fired when the widget or sub levels of its items are bound to data from the dataSource.The event handler function context (available via the this keyword) will be set to the widget instance. For additional information check the dataBound event documentation.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->dataBound('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onDataBound(e) {
        // handle the dataBound event.
    }
</script>
<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->dataBound('onDataBound');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->dataBound(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

dataImageUrlField

Sets the field of the data item that provides the image URL of the DropDownTree nodes.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->dataImageUrlField('value');
?>

dataSource

Sets the data source of the widget.

Returns

\Kendo\UI\DropDownTree

Parameters

$value \Kendo\Data\DataSource |array

Example - using \Kendo\Data\DataSource

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dataSource = new \Kendo\Data\DataSource();
$dropDownTree->dataSource($dataSource);
?>

Example - using array

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$schema = new \Kendo\Data\DataSourceSchema();
$dropDownTree->dataSource(array('schema' => $schema));
?>

dataSpriteCssClassField

Sets the field of the data item that provides the sprite CSS class of the nodes. If an array, each level uses the field that is at the same index in the array, or the last item in the array.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->dataSpriteCssClassField('value');
?>

dataTextField

Sets the field of the data item that provides the text content of the nodes. If an array, each level uses the field that is at the same index in the array, or the last item in the array.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |array

Example - using string

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->dataTextField('value');
?>

Example - using array

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->dataTextField(array());
?>

dataUrlField

Sets the field of the data item that provides the link URL of the nodes.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->dataUrlField('value');
?>

dataValueField

The field of the data item that provides the value of the widget. If an array, each level uses the field that is at the same index in the array, or the last item in the array.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |array

Example - using string

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->dataValueField('value');
?>

Example - using array

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->dataValueField(array());
?>

delay

Specifies the delay in milliseconds after which the DropDownTree will start filtering dataSource.

Returns

\Kendo\UI\DropDownTree

Parameters

$value float

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->delay(1);
?>

enable

If set to false the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input.

Returns

\Kendo\UI\DropDownTree

Parameters

$value boolean

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->enable(true);
?>

enforceMinLength

If set to true the widget will not show all items when the text of the search input cleared. By default, the widget shows all items when the text of the search input is cleared. Works in conjunction with minLength.

Returns

\Kendo\UI\DropDownTree

Parameters

$value boolean

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->enforceMinLength(true);
?>

filter

The filtering method used to determine the suggestions for the current value. Filtration is turned off by default, and can be performed over string values only (either the widget's data has to be an array of strings, or over the field, configured in the dataTextField option). The supported filter values are startswith, endswith and contains.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->filter('value');
?>

filtering

Fired when the widget is about to filter the data source.The event handler function context (available via the this keyword) will be set to the widget instance. For additional information check the filtering event documentation.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->filtering('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onFiltering(e) {
        // handle the filtering event.
    }
</script>
<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->filtering('onFiltering');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->filtering(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

footerTemplate

The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->footerTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->footerTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

headerTemplate

Specifies a static HTML content, which will be rendered as a header of the popup element.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->headerTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->headerTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

height

Sets max-height of the embedded treeview in pixels. The default value is 200 pixels. If set to "Auto" the height of the popup will depend on the height of the treeview.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |float

Example - using string

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->height('value');
?>

Example - using float

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->height(1);
?>

ignoreCase

If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default.

Returns

\Kendo\UI\DropDownTree

Parameters

$value boolean

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->ignoreCase(true);
?>

loadOnDemand

Indicates whether the child DataSources should be fetched lazily when parent groups get expanded. Setting this to true causes loading the child DataSources when expanding the parent node.

Returns

\Kendo\UI\DropDownTree

Parameters

$value boolean

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->loadOnDemand(true);
?>

messages

The text messages displayed in the widget. Use it to customize or localize the messages.

Returns

\Kendo\UI\DropDownTree

Parameters

$value \Kendo\UI\DropDownTreeMessages |array

Example - using \Kendo\UI\DropDownTreeMessages

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$messages = new \Kendo\UI\DropDownTreeMessages();
$clear = 'value';
$messages->clear($clear);
$dropDownTree->messages($messages);
?>

Example - using array

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$clear = 'value';
$dropDownTree->messages(array('clear' => $clear));
?>

minLength

The minimum number of characters the user must type before a search is performed. Set to a higher value if the search could match a lot of items.

Returns

\Kendo\UI\DropDownTree

Parameters

$value float

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->minLength(1);
?>

noDataTemplate

The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->noDataTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->noDataTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

open

Fired when the popup of the widget is opened by the user.The event handler function context (available via the this keyword) will be set to the widget instance. For additional information check the open event documentation.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->open('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onOpen(e) {
        // handle the open event.
    }
</script>
<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->open('onOpen');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->open(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

placeholder

The hint displayed by the widget when it is empty. Not set by default.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->placeholder('value');
?>

popup

The options that will be used for the popup initialization. For more details about the available options refer to Popup documentation.

Returns

\Kendo\UI\DropDownTree

Parameters

$value \Kendo\UI\DropDownTreePopup |array

Example - using \Kendo\UI\DropDownTreePopup

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$popup = new \Kendo\UI\DropDownTreePopup();
$appendTo = 'value';
$popup->appendTo($appendTo);
$dropDownTree->popup($popup);
?>

Example - using array

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$appendTo = 'value';
$dropDownTree->popup(array('appendTo' => $appendTo));
?>

tagMode

The mode used to render the selected tags when checkboxes are enabled. The available modes are: - multiple - renders a tag for every selected value - single - renders only one tag that shows the number of the selected values

Returns

\Kendo\UI\DropDownTree

Parameters

$value string

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->tagMode('value');
?>

template

Template for rendering each node.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->template('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->template(new \Kendo\JavaScriptFunction('function() { }'));
?>

text

The text of the widget used when the autoBind is set to false.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->text('value');
?>

value

Define the value of the widget. It accepts 'String' when it is in single selection mode and 'Array' when multiple selection is enabled via checkboxes property.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |array

Example - using string

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->value('value');
?>

Example - using array

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->value(array());
?>

valuePrimitive

Specifies the value binding behavior for the widget. If set to true, the View-Model field will be updated with the selected item value field. If set to false, the View-Model field will be updated with the selected item.

Returns

\Kendo\UI\DropDownTree

Parameters

$value boolean

Example

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->valuePrimitive(true);
?>

valueTemplate

The template used to render the value and the or the selected tags.

Returns

\Kendo\UI\DropDownTree

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->valueTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$dropDownTree = new \Kendo\UI\DropDownTree('DropDownTree');
$dropDownTree->valueTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>
Is this article helpful? Yes / No
Thank you for your feedback!

Give article feedback

Tell us how we can improve this article

close
Dummy