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

Column adding and copying

TreeGrid documentation

new 12.0 <Cfg> int

ColAdding

[0]
If it is possible to add new columns to grid, bit array for the column sections.
1 - middle columns, 2 - right columns, 4 - left columns. Set to 7 for all sections.
By default it is disabled!
new 12.0 <Cfg> int

ColCopying

[7]
If it is possible to copy (duplicate) columns in grid, bit array for the column sections.
1 - middle columns, 2 - right columns, 4 - left columns.
It is disabled if set ColAdding='0'.
By default it is enabled, but copying is disabled due default ColAdding='0'!
new 12.0 <C> int

CanCopy

[2/1/0]
If the column can be copied. 0 - no, 1 - inside its section, 2 also outside its section.
By default it is 0 for Panel, Index, Gantt and ConstWidth columns, 1 for columns added by AutoCols, and 2 for all other columns.
new 12.0 API method TCol[]

AddCols

(string[] cols, string tocol, bool right, bool empty = 0, bool focus = 0)
Adds or copies one or more columns to grid.
cols can be an array of columns to be copied.
Or the cols can be a number of new columns to add.
tocol is column next to place the new columns, left if right is 0 or right if right is 1.
Or the tocol can be a column section (0 - left, 1 middle, 2 right) where to place the new columns. To beginning, if right is 0, or to end, if right is 1.
If empty is 1, copies the columns empty or with the EditAttrsEmpty if set.
If focus is 1, focuses the new columns in the same row(s) as the original focus.
Returns the new added columns.
new 12.0 API event bool

OnColsAdd

(TGrid grid, string[] cols, string tocol, bool right, bool empty)
Called when new or copied columns are added to grid. Return true to suppress the action.
It is called from AddCols method and the parameters are the same.
chg 7.0 API method TCol

AddCol

(string col, int sec, int pos, object param, bool show = 0, string type = "Text", string caption = col)
Adds one new column to the table.
col is column name, sec is section of columns (0 - left, 1 - mid, 2 - right), pos is column position in its section (from 0). -1 for the last column.
param (new in 7.0) is an object with all parameters like for <C> tag, to preset them in the column, for example { Width:100, Type:"Lines", CanSort:0 }
Before 7.0 version the param was integer and specified column width, it is still supported, but not recommended.
for show = 1 is column displayed in table, for show = 0 it is hidden and can be displayed by ShowCol method.
type is set column Type attribute (just for backward compatibility, it can be set in param), caption is string displayed in all headers for this column.
New column will have default values from <D Name='C'>.
Returns new column or null if column with given name already exists.
new 12.0 <Actions>

AddCol ...F

Attached to OnClickButtonAddCol and used in Toolbar AddCol and Panel Menu
Adds one new column left to the actual or focused column.
new 12.0 <Actions>

AddColNext ...F

Not attached to any event
Adds one new column right to the actual or focused column.
new 12.0 <Actions>

AddColEnd

Attached to OnClickButtonAddCol and used in Toolbar AddCol Menu
Adds one new column on the end of variable columns section.
It always creates brand new column and ignores EditAttrEmpty attribute.
new 12.0 <Actions>

AddCols ...F

Not attached to any event, but used in Toolbar AddCol Menu
Adds the same number of new columns as actually focused columns, left to actual column or focused range.
new 12.0 <Actions>

AddColsNext ...F

Not attached to any event
Adds the same number of new columns as actually focused columns, right to actual column or focused range.
new 12.0 <Actions>

AddSelectedCols ...F

Not attached to any event, but used in Toolbar AddCol Menu
Adds the same number of new columns as actually selected columns, left to the actual or focused column.
new 12.0 <Actions>

AddSelectedColsNext ...F

Not attached to any event
Adds the same number of new columns as actually selected columns, right to the actual or focused column.
new 12.0 <Actions>

CopyCol ...F

Not attached to any event, but used in Toolbar AddCol Menu
Copies actual or focused column to the left side of itself.
new 12.0 <Actions>

CopyColNext ...F

Not attached to any event
Copies actual or focused column to the right side of itself.
new 12.0 <Actions>

CopyCols ...F

Not attached to any event, but used in Toolbar AddCol Menu
Copies all focused columns to the left side of actual column or the focused range.
new 12.0 <Actions>

CopyColsNext ...F

Not attached to any event
Copies all focused columns to the right side of actual column or the focused range.
new 12.0 <Actions>

CopySelectedCols ...F

Not attached to any event, but used in Toolbar AddCol Menu
Copies all selected columns to the left side of actual or focused column.
new 12.0 <Actions>

CopySelectedColsNext ...F

Not attached to any event
Copies all selected columns to the right side of actual or focused column.
new 12.0 <Actions>

ColCopy

Attached to OnCtrlDragHeader, can be attached only to OnDrag... event
Starts copying column by mouse dragging.
The columns can be copied inside Header or placed to DropCols cells.
new 12.0 <Actions>

ColCopySelected

Attached to OnCtrlDragHeader, can be attached only to OnDrag... event
Starts copying selected columns by mouse dragging. Fails if actual column is not selected.
The columns can be copied only inside Header. Ignores Block attributes.