News in version
TreeGrid Gantt chart SpreadSheet Examples Documentation Download Development Licensing Prices References Contacts Buy Try it free
Documentation
Search in documentation
TreeGrid versions compatibility

Changes log (txt file) Upgrading from 9.3 to 10.0 Upgrading from 5.9 to 6.0

Creating grid

Simple examples Basic information Creating grid Deleting grid Reloading grid Rendering grid Accessing grid by API

Data & communication
Data communication with server

Communication types AJAX communication AJAX SOAP envelope Submit communication Directly included data Data from JavaScript Cross domain / local load by JSONP Sessions (AJAX) Server response (AJAX) Synchronous communication (AJAX) Caching (AJAX) API (AJAX)

Download data

Settings for data download Layout XML structure Data XML structure

Upload data

Settings for data upload API for upload XML structure sent to server

Changing data from server

XML structure of download changes XML structure of request for a cell Synchronizing data with server

Input / output data formats

Complete list of tags Internal XML format Short XML format Extra short XML format DTD XML format JSON format

Cells
Cell basics

Cell type Cell format Dynamic format Dynamic type Cell value Reading / writing attributes by API Cell HTML Range or more values in one cell Cell with link URL Cell hint Cell tooltip / title Cell popup menu

Cell editing and changing values

Cell editability Defaults list Suggest list (auto complete) Changing cell value Mass cell change Clearing cells Editing cells Controlling <input> tag by JavaScript Input validation and restrictions Side checkbox Cell selecting

Calculations - cell formulas

Basics Formulas Mathematical functions Aggregate functions Special functions for actions Custom functions

Calculations - editable cell formulas

Basics Suggest list (auto complete) Actions for choosing cells Conditional functions Lookup functions Cell reference functions Logical functions Informational functions Mathematical functions Trigonometry functions Rounding numbers Number conversions String functions Date functions Summary functions Custom functions

Cell side buttons

Introduction Right side Button Left side Icon

Cell spanning

Column span Row span Dynamic spanning

Cell style and color

Basic grid style Sizing and scaling - responsive design Dynamic cell style attributes Cell CSS class Cell background color Dynamic cell border Cell HTML style Row color alteration Cell mouse cursor

Cell types
Auto type - Auto String - Text, Lines & Pass
Number - Int & Float

Format Localization

Date and time - Date

Format Calendar component Dates dialog Localization

List & combo - Enum & Radio

Introduction Definition Related lists Enum specific Radio specific

Checkbox - Bool
Action button - Button

Introduction Basic clickable button Switch button Radio / tab button Menu button Combo switch button Combo radio / tab button Special Space rows with buttons

Panel with more buttons - Panel

Definition Standard fast panel Custom panel

HTML and special types

Html type Icon type Abs type List type Editable Link type Editable Img type DropCols type Upload File type

Columns

Column basics Column index Column visibility Column visibility menu Column selecting Column tree Column position and moving Column adding and copying Column deleting Column width Column API

Rows
Row basics

Rows by functionality Rows by position Row name Row id Row index

Default rows

Description Example of default rows Example of changing default row Attributes

Row tree

Tree attributes Actions & API for expand / collapse

Row identification

Setting row id attribute Row id attribute in tree Row id created from cell values API for row ids

Row visibility
Row adding and copying

Five ways of adding rows to grid Adding and copying restrictions Adding new empty rows Copying existing rows

Row deleting Row moving and dragging Row selecting Row height Row API Space rows
Features
Sorting rows

Sort settings Controlling sort position Comparing strings Sorting actions Sorting API

Grouping rows to tree

Group settings Creating groups Comparing strings Created group rows <D Group='1'/> User interface to choose grouping Grouping actions and API

Filtering rows

Filter settings Comparing strings User interface to choose filter Filter actions and API

Searching in rows and cells

Search settings User interface for search Search actions and API

Printing grid

Print settings Choosing items to print Page size Print API

Print / export to PDF

Introduction Client side settings Printing options Client side API Server side API Data sent from client to server

Export to Excel or CSV

Introduction Basic settings Communication with server Export API Client export Server export

Import from Excel

Basic settings Sheets manipulation

Copy & paste rows via clipboard

Copy & paste permissions Copying to clipboard Pasting from clipboard

Master - detail grids

Introduction External master - detail grids Nested master - detail grids Synchronizing grids Other attributes for master - detail

Pivot tables

Pivot attributes & API Pivot formulas

External objects (like Adobe Flash) Undo & Redo
Gantt and bar chart
Gantt objects

Gantt objects list Display settings Edit settings

Main bar

Definition of main bar and plans Main bar as Task Edit settings Main bar content and side html Tip on mouse hover Vertical position and height Style specific attributes API to manipulate Main bars Actions Side text (deprecated) Real Flow (deprecated)

Run bar

GanttRun Definition Extended definition Run bar as Task Edit settings Save format Selecting Run boxes Run box content and side html Tip on mouse hover Box identification Vertical position and height Style specific attributes Overlaid (Error) boxes Containers for more boxes Dragging - moving and resizing API to manipulate Run boxes Actions Run special formulas

Summary task

Main for Main Main for Run Editable Main Editable Run

Gantt icons - Flag & Point

Flag - icon with text Point - math points

Gantt display objects

Header - column captions Cell and column Background Vertical movable Line Mark & Progress line

Gantt zoom

Zoom options Chart size limits Zoom selection Paging in Gantt chart

Dependency, constraints & schedule

Introduction Data units Defining dependencies Dependency colors and shapes Changing dependencies Correcting dependencies Scheduling algorithm Project date constraints Task date constraints Critical path - Slack (Float)

Gantt calendars

Global base calendar Local calendar Calendar list Calendars dialog Other settings

Gantt resources

Resources list Resources assign Resources filter Resources calculations Availability chart Resource usage chart Generated resource usage chart

Gantt popup menu Gantt API
Line and XY points charts

Charts in grid cells Chart JSON definition Base chart settings Basic attributes Size Axis and caption Individual chart lines Data sources Visual settings API for standalone usage

Paging in large grids
Paging root rows

Paging types and attributes Auto adding root pages API for paging

Pager components

Side pager Side pager type Pages Side pager type Gantt Side pager type Custom Pager with navigation buttons & edit Pager as list of page indexes

Paging in tree

ChildPaging - load / render on expand MaxChildren - limit children count ChildParts - load / render on scroll

Paging columns

Paging types and attributes Auto adding column pages API for column paging

Server paging

Server paging for root rows Server communication in root paging Root paging in very large tables Server paging in tree Server communication in tree paging XML Request for Data in root paging XML Download Data in root paging XML Request for root Page / children XML Download root Page / children API for server paging

TreeGrid DLL/SO for server paging

Introduction Compatibility with TreeGrid control Using TreeGrid server DLL/SO ASP.NET C# ASP.NET VB PHP JSP Java TreeGrid server concepts Function reference Calculations

JSON menus and dialogs
JSON menu description JSON menu definition example
Menu settings

Base attributes Visual settings Key navigation Behavior Size and scroll

Menu item settings

Base attributes Clickable item Inactive caption Collapsible sub level Popup sub menu Columns Bool item Enum item Edit item

Custom menu in JavaScript

Show custom menu Custom menu position Custom menu advanced settings Custom menu JavaScript events Custom menu JavaScript methods

Calendar dialog Custom calendar & JavaScript events Custom dialog in JavaScript
Global grid settings
Grid size and scroll

Default behavior Maximize grid height and width Update size according to the content Let a user to control the grid size Widths of individual sections Other scrolling attributes and API

Media rules - responsive design
Grid cursor - Focus & hover

Focused cell and row Focused cell range Move and copy focused cells Filling cell values by dragging Tabulator navigation Key navigation Cursor look - focus & hover

Selecting rows, cells and columns

Selecting base Selecting rows Selecting cells Selecting columns

Global settings

Status messages Configuration menus Configuration menu - options Configuration menu - columns Configuration menu - print / PDF Configuration menu - export Default toolbar Language & regional setup (Text.xml) Useful API function Help file

Animations

Animations base Row animations Column animations Cell animations Animations for undo / redo Animations for server side changes Dialog animations

Grid configuration in cookies
Mouse & key events & actions

List of event handler types TreeGrid mouse events Mouse event names Key and mouse button prefixes Touch event names Event targets Assigning event actions / callbacks Event action parameters Calling actions from JavaScript Creating custom actions Focused vs. Actual cell TreeGrid key events JavaScript API events

Mouse API event TreeGrid files
Debugging and testing

Debug window Automated testing

Cell side buttons

TreeGrid documentation

Any cell can display a right or left side button.
It is also possible to have both left and right side buttons in one cell.
And it is also possible to have two right buttons (but not two left).
Only right side Button can display custom HTML code or <BUTTON> tag. But not in Space row.

Right side button

chg 6.0 upd 12.0 <C> <cell> string

Button

Cell right side button with various functionality. It can be used along with Icon.
empty stringTo hide the predefined button for Date type.
icon source file Shows custom icon, the icon width is set by WidthPad for non Space cell and by ButtonWidth for Space cell.
The Button is an URL to some GIF, PNG, JPG. On mouse click it calls custom event OnButtonClick.
This button type is identified as "Icon" in events.
The URL is relative to actual page URL, not to Grid.css, not to XML data!
Defaults Shows Defaults icon for popup defaults menu.
On mouse click it shows popup menu with predefined default values to select one or more for them like in combo box.
The list of default values is defined by Defaults attribute.
DatesShows Dates icon for popup Dates menu.
ExpandShows Expand / Collapse button to expand rows and / or columns. See column tree.
CheckShows checkbox, see Side checkbox.
File(new 12.0) Shows File icon, usually to choose files for File type cell.
Clear(new 12.0) Shows Clear icon to clear the cell value.
Button Shows HTML <BUTTON>, the button text is specified by ButtonText attribute.
Remember, the width of the button must be the same for all cells in the column and is specified by WidthPad attribute.
After a user clicks the button, it is called OnButtonClick event.
Can be set only to Button, not to Icon. And cannot be set to Space cell.
Html Any HTML code displayed as is. It can be <button>, <img>, <a> tag or any other HTML code. It is specified by ButtonText attribute.
It can contain also any predefined JavaScript onclick code.
Remember, the width of the button must be the same for all cells in the column and is specified by WidthPad attribute.
After a user clicks the button, it is called OnButtonClick event.
Can be set only to Button, not to Icon. And cannot be set to Space cell.

There are also four values Date, Sort, Filter, Enum that are filled automatically by grid and are used explicitly only in rare cases, e.g. to show it in Button instead of Icon or vice versa.
chg 6.0 <C> int

WidthPad

[20]
Width of right side Button in non Space row. In pixels.
It is the same for whole column, so all right side buttons in one column have the same width!
It affects also sort icons in header! To avoid it, change the header button to icon by <Header Col1Icon='Sort' Col1IconAlign='Right'/>. Remember, it will overflow the icon if the caption is too wide.
new 6.0 <Space cell> int

ButtonWidth

[20]
Width of right side Button in Space row. In pixels.
new 6.2 <Space cell> string

ButtonAlign

['Right']
In Space row the button can be displayed also on left side by ...ButtonAlign='Left'.
<C> <cell> string

ButtonText

<BUTTON> caption for custom Button type Button.
HTML code for custom Button type Html.
<Actions>

ButtonClick ...F

Calls OnButtonClick event for actual or focused cell with custom Button type Button, Icon or Html.
upd 6.0 API event bool

OnButtonClick

(TGrid grid, TRow row, string col, int x, int y)
Called on click to custom Button type Button, Icon or Html.
x, y is click position inside the button.
Return true to suppress the default action, especially for Button Html.
For read only cells with only one side button is called for the whole cell, opposite to OnClickSide.
new 6.0 <XML event> void

OnClickSide

(TGrid Grid, TRow Row, string Col, TEvent Event)
Standard column, row, cell or Actions attribute containing JavaScript code.
It is called on click to left or right side Button or Icon.
It is standard TreeGrid mouse event, here is just mentioned to not forget its possibility when handling custom side button clicks.
Example: <I Col1OnClickSide='alert("clicked column "+Col);'/>
If the cell has both Button and Icon, you can distinguish the clicks by defining OnClickSideButton and OnClickSideIcon events.
For read only cell with only one side button is this event called only on click to the button, but the OnClickSideButton / Icon is called for click to the whole cell.

Left side icon

new 6.0 upd 12.0 <C> <cell> string

Icon

Cell left side button with various functionality. It can be used along with Button.
It can be used also to set background image of the cell (Icon='Icon' IconWidth='0' IconSrc='url').
It can be also positioned right to replace Button or even to show two side right buttons, but check the problems in IconAlign description. The Icon rendering is slightly faster than the Button.
empty stringTo hide the predefined icon for Enum type.
icon source file Shows custom icon, the icon width is set by IconWidth. The Icon is an URL to some GIF, PNG, JPG.
On mouse click it calls custom event OnIconClick.
This button type is identified as "Icon" in events.
The URL is relative to actual page URL, not to Grid.css, not to XML data!
Defaults Shows Defaults icon for popup defaults menu.
On mouse click it shows popup menu with predefined default values to select one or more for them like in combo box.
The list of default values is defined by Defaults attribute.
DatesShows Dates icon for popup Dates menu.
ExpandShows Expand / Collapse button to expand rows and / or columns. See column tree.
CheckShows checkbox, see Side checkbox.
File(new 12.0) Shows File icon, usually to choose files for File type cell.
Clear(new 12.0) Shows Clear icon to clear the cell value. Shown automatically for not empty File type cell.

There are also four values Date, Sort, Filter, Enum that are filled automatically by grid and are used explicitly only in rare cases, e.g. to show it in Button instead of Icon or vice versa.
new 6.0 <C> <cell> string

IconAlign

['Left']
Position of the cell side Icon button. By default is the Icon placed left side of the cell.
Supported values are "Left", "Right", "Center".
You can place the icon on the right side by setting IconAlign="Right". Use it only if Button is already set or you cannot use Button due WidthPad difference.
You can place the icon center by setting IconAlign="Center", it is intended only for empty cells or to use Icon as background image.
Attention, if the Icon is placed right side and the cell content is wider than the cell, the text is displayed through this icon in many browsers due wrong implementation of CSS right padding. For such cells prefer the Button attribute if possible.
new 6.0 <C> <cell> int

IconWidth

[20]
Width in pixels of custom Icon (Icon="icon source file").
The icon should not be wider than IconWidth, otherwise it is overwritten by the cell text.
The IconWidth can be also set to 0 to use the Icon as background image of the cell.
new 7.0 <Space cell> int

Height

Height of the cell in pixels.
Set it when the Icon in Space cell is not visible whole.
new 12.0 <Cfg> bool

EscapeImages

[0]
Set it to 1 if any custom image url contains white spaces or ' ( ) &
new 6.0 <Actions>

IconClick ...F

Calls OnIconClick event for actual or focused cell with custom Icon type Icon.
new 6.0 API event bool

OnIconClick

(TGrid grid, TRow row, string col, int x, int y)
Called on click to custom Icon type Icon.
x, y is click position inside the icon.
Return true to suppress the default action.
For read only cells with only one side button is called for the whole cell, opposite to OnClickSide.
new 6.0 <XML event> void

OnClickSide

(TGrid Grid, TRow Row, string Col, TEvent Event)
Standard column, row, cell or Actions attribute containing JavaScript code.
It is called on click to left or right side Button or Icon.
It is standard TreeGrid mouse event, here is just mentioned to not forget its possibility when handling custom side button clicks.
Example: <I Col1OnClickSide='alert("clicked column "+Col);'/>
If the cell has both Button and Icon, you can distinguish the clicks by defining OnClickSideButton and OnClickSideIcon events.
For read only cell with only one side button is this event called only on click to the button, but the OnClickSideButton / Icon is called for click to the whole cell.