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 deleting

TreeGrid documentation

new 12.0 <Cfg> bool

ColDeleting

[0]
If it is possible to delete columns from grid.
By default it is disabled!
<Cfg> bool

ShowDeleted

[1] Saved to cookies
If deleted rows and columns are visible and colored.
If set to 1, deleted rows and columns are still visible and can be undeleted. The deleted rows are colored in red, it can be changed in Grid.css.
If set to 0, deleted rows and columns are hidden and cannot be undeleted by a user.
Setting to 1 when AutoUpdate is true has no effect � the rows are immediately deleted.
new 12.0 <Cfg> int

DeleteMessage

[1]
If the confirmation message for deleting row, selected rows, column and selected columns will be shown.
0 - never, 1 - only if ShowDeleted is on, 2 always.
new 12.0 <C> bool

CanDelete

[1/0]
If the column can be deleted.
It is 1 for all columns except Panel, Index and Gantt.
new 12.0 <C> bool

Deleted

[0]
It is set to 1 when the column has been deleted.
The column is hidden if ShowDeleted='0' or visible and colored red (by default setting in Grid.css) when ShowDeleted='1'.
If the column is shown, it can be undeleted.
The deleted column is ignored in summary calculations. The deleted column cannot be moved.
After uploading changes to server or calling AcceptChanges() the deleted column is physically removed from grid.
new 12.0 API method bool

OnCanColDelete

(TGrid grid, string col, int type, string[] cols)
Called before column is deleted or undeleted. Called to find out if and how can the column be deleted or undeleted.
type = 0 � cannot delete, 1 � user must confirm deleting, 2 - delete, 3 � undelete.
Return new type. Or return the type to not change the behavior.
Returning 2 for deleted column and 3 for not deleted column has no effect.
If fires when deleting selected rows, type = 1 has no meaning.
cols are set if called on deleting selected columns and contains all the selected columns to delete or undelete. For every of these columns is called the OnCanColDelete.
new 12.0 API method void

OnColDelete

(TGrid grid, string col)
Called when the column is deleted.
new 12.0 API method void

OnColUndelete

(TGrid grid, string col)
Called when the column is undeleted.
new 12.0 API method bool

DeleteCol

(string col, int type, bool test)
Deletes / undeletes column from grid. Displays changes. Prepares deleting and calls DeleteColT ( ).
type = 1 � delete + confirm dialog, 2 � delete, 3 � undelete.
Only marks the column as deleted.
Returns true if the deletion was done.
If set test = 1, does not delete column, only tests if it is possible, but does not show confirm message, takes it as confirmed.
new 12.0 API method bool

DeleteColT

(string col, int type)
Deletes / undeletes column from grid. Displays changes. type = 2 � delete, 3 � undelete.
new 12.0 API method void

RemoveCol

(string col)
Physically removes the column from grid and data. The column is really deleted, not just marked!
For marking column as Deleted use DeleteCol() instead.
Remember, removed column cannot be used in any API function, especially take care in loops, you cannot use GetNextCol / GetPrevCol functions with removed column.
new 12.0 API method int

DeleteCols

(string[] cols, int del = 1)
Deletes (del = 1), or undeletes (del = 0) or removes (del = 2) all given columns in grid.
Returns final count of affected columns. Deletes / undeletes column from grid. Displays changes. type = 2 � delete, 3 � undelete.
new 12.0 <Actions>

DeleteCol ...F

Attached to OnClickPanelColDelete event
Deletes actual or focused column, the column is marked as Deleted.
new 12.0 <Actions>

UndeleteCol ...F

Attached to OnClickPanelColDelete event
Undeletes actual or focused column.
new 12.0 <Actions>

RemoveCol ...F

Not attached to any event
Physically removes actual or focused column.
new 12.0 <Actions>

DeleteCols ...F

Not attached to any event
Deletes all focused columns, the columns are marked as Deleted. Without ...F fails if the actual column is not focused.
new 12.0 <Actions>

UndeleteCols ...F

Not attached to any event
Undeletes all focused columns. Without ...F fails if the actual column is not focused.
new 12.0 <Actions>

RemoveCols ...F

Not attached to any event
Physically removes all focused columns. Without ...F fails if the actual column is not focused.
new 12.0 <Actions>

DeleteSelectedCols ...F

Not attached to any event
Deletes all selected columns, the columns are marked as Deleted. Without ...F fails if the actual column is not selected.
new 12.0 <Actions>

UndeleteSelectedCols ...F

Not attached to any event
Undeletes all selected columns. Without ...F fails if the actual column is not selected.
new 12.0 <Actions>

RemoveSelectedCols ...F

Not attached to any event
Physically removes all selected columns. Without ...F fails if the actual column is not selected.