toolbar in JQuery TreeGrid widget

19 Jan 20186 minutes to read

In TreeGrid we can show/hide the Toolbar by using the showToolbar property of toolbarSettings. We can add default toolbar items by toolbarItems. User can also create a custom toolbar items by using the customToolbarItems.

Default Toolbar Items

Using TreeGrid default toolbar items we can perform below operations.

  • Add: To add new task.

  • Edit:To edit a selected task.

  • Delete: To delete a selected task.

  • Cancel: To cancel the edited changes in a task.

  • Update: To save the edited changes in a task.

  • ExpandAll: To expand all the TreeGrid rows.

  • CollapseAll: To collapse all the TreeGrid rows.

  • PdfExport: To export TreeGrid in PDF format.

  • ExcelExport: To export TreeGrid in Excel format.

  • Search: To search the TreeGrid content.

We can enable TreeGrid toolbar by using below code example:

  • JS
  • $("#TreeGridContainer").ejTreeGrid(
        toolbarSettings: {
            showToolbar: true,
            toolbarItems: [

    The following screenshot displays the toolbar option in TreeGrid control.



    To perform add, edit, delete, cancel and update using Toolbar items we need to enable add/edit/delete using the editSettings.

    Custom Toolbar Items

    CustomToolbarItems allows us to insert custom icons and custom template in TreeGrid toolbar. By using below properties we can customize TreeGrid toolbar as per our requirement.

    • text: To insert the custom icons in toolbar using CSS class name selector.

    • templateID: To insert the custom icons in toolbar using script templates. Using this property we can bind HTML elements and other EJ controls to TreeGrid toolbar.

    • tooltipText: Displays tooltip text for the custom icons.

    To insert EJ Controls in TreeGrid toolbar we need to initiate the control in create client-side event. In toolbarClick client-side event we can bind actions to the custom toolbar items.

  • HTML
  • <div id="TreeGridContainer" style="height:400px;width:100%"></div>           
        <script id="ColumnVisibility" type="text/x-jsrender">
            <input id="dropdownContainer" />
        <script type="text/javascript">     
            $(function () {
                     toolbarClick: function (args) {
                        if (args.itemName == "Reset") {
                           //we can bind the custom actions here
                    toolbarSettings: {
                        showToolbar: true,
                         customToolbarItems: [
    		    {templateID: "#ColumnVisibility",tooltipText:"Column Visibility" },
                    create: function (args) {
    		    //Here we can append custom EJ controls
        <style type="text/css" class="cssStyles">    
            #TreeGridContainer_ColumnVisibility {
                padding-top: 2px;
                padding-bottom: 0px;
            .Reset:before {
                content: "\e677";


    Click here to view the demo sample for custom toolbar item