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

Panel with more buttons - Panel

TreeGrid documentation

Panel type displays one or more clickable icon buttons in one cell.
<C> <cell> string

Type

["Panel"] Type = "Panel"
To define Panel type, set column or cell attribute Type to "Panel".
There is a shortcut in XML, as column <Panel /> instead of <C Name="Panel"/>.
new 12.0 <I> string

Kind

["Panel"] Kind = "Panel"
If row Kind is set to "Panel" it sets Type="Panel" for every row cell and also assigns default row "Panel" with the panel column actions and definitions.
There is a shortcut in XML, as row <Panel /> instead of <I Kind="Panel"/>.
new 13.0 <I> bool

ColorPanel

[0]
If the Panel type cell will be colored like normal cell.

Predefined Panel column

Every grid has predefined one column as Type="Panel" Name="Panel" always displayed on grid left side.
You can move this column to another section by placing <Panel Name="Panel"/> to any column section to place the panel here.
Or to hide the default panel, set <Panel Visible='0'/> in the root.
To not let user to show the panel from menu set <Panel Visible='0' CanHide='0'/>
The default panel is defined by XML root tag <Panel>.
Grid can have more standard panels defined by <Panel/> tag with different Name.

The default Panel can show up to four predefined buttons, always in this order: Move, Select, Delete and Copy.
In Header row there are predefined buttons: MoveAll, SelectAll, DeleteAll, CopyAll.
Prior to 12.0 the Header buttons were named Move, Select, Delete, Copy and were identified in events as HeaderXXX instead of PanelXXX.
<C> bool

Move

[0]
If the default Panel button Move / MoveAll is visible. This button is hidden also if <Cfg Dragging="0"/>. This button is inactive when the row has CanDrag='0'.
Dragging this button moves the row. Use this button if dragging row by cells has different function like selecting cells.
Used only if the Buttons and the cell value are not set.
upd 9.2 <C> int

Select

[1]
If the default Panel button Select / SelectAll is visible. This button is hidden also if <Cfg Selecting="0"/>. This button is inactive when the row has CanSelect='0'.
Click to this button selects the whole row. Dragging this button selects rows range.
(Since 9.2) If set to 2, it is similar to 1, but the button is checked only if the whole row is selected, not only individual cells.
Used only if the Buttons and the cell value are not set.
<C> bool

Delete

[1]
If the default Panel button Delete / DeleteAll is visible. This button is hidden also if <Cfg Deleting="0"/>. This button is inactive when the row has CanDelete='0'.
Click to this button deletes row or undeletes deleted row.
Used only if the Buttons and the cell value are not set.
upd 6.0 <C> bool

Copy

[0]
If the default Panel button Copy / CopyAll is visible. This button is hidden also if <Cfg Copying="0"/>. This button is inactive when the row has CanCopy='0'.
Click to this button shows popup menu for copying and adding rows. The menu is defined by attribute PanelCopyMenu.
Used only if the Buttons and the cell value are not set.
new 6.0 <Cfg> bool

FastPanel

[1]
For 1 it displays standard panel as one image to speed rendering up. Used only if the Buttons and the cell value is not set.
For 0 it displays all icons separately.

Custom panel

Panel can contain one or more custom buttons set in cell value or by Buttons attribute.
You can specify the custom button name in value or Buttons and set its parameters as separate attributes.
The custom button name is set as xxx in the next documentation.
new 6.0 upd 12.0 <C> <I> string[ ]

Buttons

Comma separated list of buttons on panel.
One panel button can be one of predefined buttons or any custom button name. The predefined buttons are:
Move (move row), Select (select row), Delete (delete row), Copy (copy or add row),
(since 12.0) MoveAll (not used), SelectAll (select all rows), DeleteAll (delete selected rows), CopyAll (copy or add selected rows),
(since 12.0) ColMove (move column), ColSelect (select column), ColDelete (delete column), ColCopy (copy or add column),
(since 12.0) ColMoveAll (not used), ColSelectAll (select all columns), ColDeleteAll (delete selected columns), ColCopyAll (copy or add selected columns),
(since 6.4) If button name is set to Empty or to empty string, empty space is shown instead of button, EmptyWidth pixels wide.
Since 12.0 it is read from row with Kind="Panel" instead of column.
If the custom button has not defined its icon, it is rendered as HTML <BUTTON>, see UseButton.
For example <C Name='Col1' Buttons='Select,Add,Delete,Edit' Add='Add.gif' Edit='../Icons/Edit.gif' EditWidth='20' />
For backward compatibility with prior to 12.0, the Move, Select, Delete and Copy buttons in Header row are automatically renamed to MoveAll, SelectAll, DeleteAll and CopyAll. And checks row CanMove, CanDelete, CanSelect and CanCopy attributes and for 0 hides the button.
new 6.0 upd 12.0 <cell> string[ ]

value

Comma separated list of buttons on panel.
The same as Buttons, but it is set in cell value and can be also calculated by Formula.
new 6.0 upd 12.0 <C><I><cell> string

xxx

Image url for the custom panel button.
Since 12.0 it can be used also for standard Panel buttons like Select or Delete. For Select the on state can be set by xxx1 attribute like <Panel Select="Off.gif" Select1="On.gif"/>.
Since 12.0 it is read from row with Kind="Panel" instead of column.
If this attribute is missing, the custom panel button is displayed as <button> tag with caption xxx.
new 6.0 upd 12.0 <C><I><cell> int

xxxWidth

[from Grid.css]
Width of the custom panel button.
Since 12.0 it can be used also for standard Panel buttons like Select or Delete with custom icon.
Since 12.0 it is read from row with Kind="Panel" instead of column.
Default value is set in Grid.css, class GxPanelImage.
new 6.0 chg 12.0 <XML event> void

OnClickPanelxxx

(TGrid Grid, TRow Row, string Col, TEvent Event)
Standard column, row, cell or Actions attribute containing JavaScript code.
It is called on click to the cell part, panel button. Since 12.0 it is called also for Header Panel.
It is standard TreeGrid mouse event, here is just mentioned to not forget its possibility when handling Panel button clicks.
Example: <I Col1='Add,Select' Add='Add.gif' Col1OnClickPanelAdd='alert("clicked add in column "+Col);'/>
new 6.0 deleted 12.0 <XML event> void

OnClickHeaderxxx

(TGrid Grid, TRow Row, string Col, TEvent Event)
The OnClickPanelxxx replacement for Header row.
new 12.0 <C><I><cell> string [*]

PanelxxxMenu

Menu for the individual Panel button.
new 6.0 chg 12.0 <C><I><cell> string

PanelxxxTip

Tooltip text for Panel button. Since 12.0 it is called also for Header Panel.
Since 12.0 it is read from row with Kind="Panel" instead of column.
new 6.0 deleted 12.0 <C><I><cell> string

HeaderxxxTip

Tooltip text for Panel button in Header row
new 6.0 chg 12.0 <C><I><cell> string

PanelxxxCursor

["pointer"]
Mouse cursor displayed on mouse hover Panel button. Since 12.0 it is called also for Header Panel.
It can be standard CSS cursor name: auto, crosshair, default, pointer, move, e-resize, ne-resize, nw-resize, n-resize, se-resize, sw-resize, s-resize, w-resize, text, wait, help.
It works only for image buttons, not for <button>.
Since 12.0 it is read from row with Kind="Panel" instead of column.
new 6.0 deleted 12.0 <C><I><cell> string

HeaderxxxCursor

["pointer"]
The PanelxxxCursor replacement for Header row.
<C><cell> string

Formula

Standard Formula attribute for Calculated row, here is stated just to not forget its advantage for Panel buttons.
The formula can return a comma separated list of the panel buttons for the row - you can return different buttons lists according to various formula sources.
new 11.0 <Cfg> int

UseButton

[0]
How the TreeGrid buttons are rendered.
Bit array: 1.bit for type Button with Button="Button", 2. bit for right side button with Button="Button", 3. bit for type Panel custom button.
0 - It renders the buttons as TreeGrid styled button done by <u> tag.
1 - It renders the buttons as HTML <button> tag. Set UseButton='7' for all three type buttons. Default behavior before version 11.0.