\Kendo\UI\TreeListToolbarItem

A PHP class representing the toolbarItem setting of TreeListToolbar.

Methods

click

The click handler of the toolbar command. Used for custom toolbar commands.

Returns

\Kendo\UI\TreeListToolbarItem

Parameters

$value \Kendo\JavaScriptFunction

Example

<?php
$toolbarItem = new \Kendo\UI\TreeListToolbarItem();
$toolbarItem->click(new \Kendo\JavaScriptFunction('function() { }'));
?>

icon

Specifies the icon's name that will be rendered inside the toolbar button. When you set this option, the TreeList renders an additional span element inside the toolbar button which has a name set to the option value. This approach allows you to display an icon inside your custom toolbar commands.

Returns

\Kendo\UI\TreeListToolbarItem

Parameters

$value string

Example

<?php
$toolbarItem = new \Kendo\UI\TreeListToolbarItem();
$toolbarItem->icon('value');
?>

imageClass

A class name that will be rendered inside the toolbar button. When you set this option, the TreeList renders an additional span element inside the toolbar button which has a class name set to the option value. This approach allows you to display an icon inside your custom toolbar commands.

Returns

\Kendo\UI\TreeListToolbarItem

Parameters

$value string

Example

<?php
$toolbarItem = new \Kendo\UI\TreeListToolbarItem();
$toolbarItem->imageClass('value');
?>

name

The name of the toolbar command. Can be either a built-in ("create", "excel", or "pdf") or a custom string. The name is output in the HTML as a value of the data-command attribute of the button.

Returns

\Kendo\UI\TreeListToolbarItem

Parameters

$value string

Example

<?php
$toolbarItem = new \Kendo\UI\TreeListToolbarItem();
$toolbarItem->name('value');
?>

template

The template which renders the command. By default renders a button. Uses the template for a ToolBar item toolbar.items.template

Returns

\Kendo\UI\TreeListToolbarItem

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

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

Example - using \Kendo\JavaScriptFunction

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

text

The text that is displayed by the command button. If not set, the TreeList will use the name` option as the button text instead.

Returns

\Kendo\UI\TreeListToolbarItem

Parameters

$value string

Example

<?php
$toolbarItem = new \Kendo\UI\TreeListToolbarItem();
$toolbarItem->text('value');
?>
In this article
Not finding the help you need?