|
Documentation glossary | Information about the documentation structure and look |
|
Attribute list and search | List of all attributes according its place, file and section |
Upgrading from 5.9 to 6.0 | List of all deleted, renamed and changed items between 5.9 and 6.0 |
|
Documentation index | Short navigation in this document |
Creating grid | Creating grid and data communication - AJAX, Submit, XML formats |
Cells | Cell and column attributes and editing values |
Individual cell types | Cell and column types, formats and features |
Columns | Attributes for whole column like width and position |
Rows | Row manipulation |
Features | Tree, Sorting, Grouping, Filter, Search, Export, Print, Undo, ... |
Gantt chart | Interactive Gantt chart - project schedule chart |
Paging in grid | Various types of paging - how to show large grids, TreeGrid server DLL/SO |
Popup menus and dialogs | Cascade menus with various features independent on TreeGrid |
Global settings | Various grid settings like size, scroll, cursor, cookies, ... |
|
Creating grid and data communication |
|
Creating grid | Basic grid creating and manipulation |
Examples of placing grid to page | Examples of various ways of grid creating |
Basic information | How to place grid to page |
Creating grid | Ways of creating grid and placing it to page |
Deleting grid | Deleting grid from page and clearing resources |
Reloading grid | Reloading grid with the same or new data |
Rendering grid | API methods and events used during grid rendering (not loading) |
Accessing grid by API | Grid id and Index and global Grids array |
|
Data communication with server | AJAX and submit communications with server |
AJAX communication | Asynchronous or synchronous AJAX communication (via XmlHttpRequest) |
AJAX SOAP envelope | AJAX communication with XML in SOAP envelope |
Submit communication | Synchronous communication via whole page (<form>) submit |
Directly included data | XML included directly in <treegrid>/<bdo> tag in HTML page |
Sessions (AJAX) | Identifying user session on server |
Server response (AJAX) | <IO> tag with response result |
Synchronous communication (AJAX) | Synchronous AJAX communication and synchronous creating |
Caching (AJAX) | How to force browser to use newest version of XML files |
API (AJAX) | API properties, methods and events to control AJAX communication |
|
Download data | Attributes and XML structures for data download |
Settings for data download | All data sources and API events for data download |
Layout XML structure | Defining layout XML - grid columns and other settings |
Data XML structure | Defining data XML - data rows with cells |
|
Upload data | Attributes and XML structures for uploading changes to server |
Settings for data upload | All data sources for uploading changes to server |
API for upload | API methods and events for uploading changes to server |
XML structure sent to server | Defining upload XML with changed rows or the whole grid |
|
Changing data from server | Changing data in grid from server |
XML structure with downloaded changes | Response sent from server to change grid content |
XML structure with request for a cell | Request for downloading one cell content sent to server |
Synchronizing data with server | Periodical check / server push / long polling |
|
Input / output data formats | Description and types of data formats used in grid |
Complete list of XML tags | Description of all XML tags used in TreeGrid XML/JSON formats |
Internal XML format | Standard TreeGrid XML format |
Short XML format | XML format to shorten XML length |
Extra short XML format | XML format to more shorten XML length |
DTD XML format | XML format compatible with DTD validation |
JSON format | JSON format with JavaScript object syntax |
|
Cells |
|
Cell basics | Basic settings for individual cells or whole columns |
Cell type | Type attribute and its API |
Cell format | Format attribute and its API |
Cell value | Basics for cell value and its reading by API |
Reading / writting attributes by API | GetAttribute / SetAttribute |
Cell HTML | RefreshRow, RefreshCell and GetCell methods |
Range or more values in one cell | Range attribute, date and number ranges or list of text values |
Cell with link URL | Link attribute |
Cell hint | Showing the whole cell content on mouse hover |
Cell tooltip / title | Showing any information for cell as tooltip |
Cell popup menu | Right click context menu for cell |
|
Cell editing and changing values | Cell editing and changing values |
Cell editability | Permit editing of individual cells |
Defaults list | Popup menu with predefined cell values |
Suggest list (auto complete) | Automatic popup menu with suggested values while editing |
Changing cell value | Changing value and reading changes |
Editing cells | Controlling editing and various edit modes |
Input validation and restrictions | EditMask, ResultMask and validate on save |
|
Calculations - cell formulas | Computing cell values by cell formulas like in MS Excel |
Basics | XML attributes and API for calculations |
Formulas | Syntax in cell formulas |
Mathematical functions | Mathematatical functions and constants used in formulas |
Aggregate functions | Functions like sum() or count() used in formulas |
Special functions for actions | Functions choose() and split() used in formulas |
Custom functions | How to define custom function and use them in formulas |
|
Cell side buttons | Left and right side button or icon |
Right side Button | Right side button or icon |
Left side Button | Left or right side icon or cell background image |
|
Cell spanning | Spanning cells between columns and rows |
Column span | Horizontal spanning among columns |
Row span | Vertical spanning among rows |
Dynamic spanning | Functions and actions for spanning and splitting spanned cells |
|
Cell style and color | Cell settings for style and look |
Basic grid style | Choosing one from predefined grid styles |
Special cell style attributes | Specific attributes like Wrap or Align |
Cell CSS class | Setting specific CSS classes to cell and cell content |
Cell background color | Computing cell background color |
Row color alteration | Different color or class for odd rows |
Cell mouse cursor | Setting mouse cursor when hovering cell |
|
Individual cell types |
|
Text types | Single and multiline editable texts (Text, Lines, Pass types) |
|
Number types | Formatted and editable number types (Int, Float types) |
Localization of numbers | How to specify number format according to language |
|
Date and time | Formatted and editable date and time, calendar component (Date type) |
Calendar component | Date picker dialog to choose date or date ranges |
Dates dialog | Dialog for choosing more date ranges with repeater and assigned values |
Localization of dates | How to specify date format according to language |
|
Enum and Radio | Selecting one or more values from combo box or radio list (Enum, Radio, Select types) |
Related lists | Choosing list items according to value in another cell |
Enum specific | Attributes specific for Enum type |
Radio specific | Attributes specific for Radio type |
|
Checkbox | Clickable checkbox with two or three states (Bool type) |
|
Action button | Html or image button with action and various functionality (Button type) |
Basic clickable button | Clickable button, after click there is called predefined action |
Switch button | Button with two states on / off |
Radio / tab button | Group of switch buttons, only one can be on |
Menu button | Button with popup menu to choose action |
Combo switch button | Switch button with more possible states chosen from popup menu |
Combo radio / tab button | Group of combo switch buttons, only one can have set state other than off |
|
Panel with clickable buttons | Group of more clickable buttons in one cell (Panel type) |
Standard fast panel | Predefined panel with Select, Delete, Copy and Move buttons |
Custom panel | Panel with user defined buttons |
|
HTML and special types | Various types with specific functionality |
Html type | Noneditable HTML code without any special feature |
Icon type | Noneditable image in cell, fast |
Abs type | One or more HTML elements absolutely positioned inside the cell in layers, noneditable |
List type | Noneditable HTML type to show more values with the same repeated parts for many rows |
Editable Link type | Editable link - supports editing of both text and URL |
Editable Img type | Editable image - supports editing of image URL, size and link |
DropCols type | Special interactive area to drag column captions here |
|
Columns |
|
Column basics | Column defining, name and caption |
|
Column visibility | Column visibility, showing and hiding columns |
Columns visibility menu | Selecting displayed columns from menu |
|
Column tree | Tree in columns, expanding / collapsing columns, nested columns |
|
Column position and moving | Left, mid and right columns and column dragging |
|
Column width | Setting column width, computed width and resizing column by mouse |
|
Column API | API methods and properties for iterating columns |
|
Rows |
|
Row basics | Row types, kinds and visibility |
Rows by functionality | Row Kind attribute - Data, Space and special rows |
Rows by position | Row Fixed attribute - Variable (scrollable), Fixed (Head,Foot) and Space (Solid) rows |
Rows visibility | Showing and hiding rows |
Row name | Naming rows in messages to users |
|
Default rows | Predefined row and cell attributes, values and behavior |
Default rows basics | How to define default rows |
Columns visibility menu | Selecting displayed columns from menu |
|
Row id | Row identification on server |
Setting row id attribute | Simple row identification |
Row id attribute in tree | Identifying row by its and parent id |
Row id created from cell values | Using one or more (editable) columns as row identity |
Example of default rows | Sample XML with defined and used <D> tags |
Example of changing default rows | Updating row when it gets children and becomes parent row or looses its children and becomes empty |
Items related to default rows | Attributes of <D>,<I> and <Root> tag for default rows |
|
Row adding and copying | Adding new rows or copying rows |
Five ways of adding rows to grid | Adding, copying, dragging, moving from another grid, pasting from clipboard |
Adding and copying restrictions | How to restrict where, which rows can be added or copied |
Adding new empty rows | Creating new rows |
Copying existing rows | Duplicating one or more selected rows |
|
Row deleting | Deleting one row or more selected rows |
|
Row moving and dragging | Moving or dragging one row or more selected rows |
|
Row and cell selecting | Selecting one or more rows or cell range |
Row and cell selecting | Selecting one or more rows or cell range |
Filling cell values by dragging | Automatic filling cell values in range according to the first cell value |
|
Row height | Specifying minimal, maximal and automatic row height |
|
Row API | Accessing and iterating rows by API |
|
Space rows | Solid space rows - rows without scrolling |
|
Features |
|
Tree in grid | Displaying TreeGrid |
Tree attributes | Settings to show and handle tree in grid |
Actions and API for expand / collapse | How to expand / collapse one or more rows |
|
Sorting rows | Sorting rows accorording to one or more columns |
Sort setting | Basic sort attributes |
Controlling sort position | Specifying how individual row will be sorted |
Comparing strings | Case sensitivity, localized comparing, white characters |
Sorting actions | Actions for sorting |
Sorting API | API events and methods for sorting |
|
Grouping rows to tree | Grouping rows accorording to the same values in one or more columns |
Group setting | Basic group attributes |
Creating groups | Specifying how individual row will be grouped |
Comparing strings | Case sensitivity, localized comparing, white characters |
Created group rows <D Group='1'/> | Controlling created group rows |
User interface to choose grouping | <Group> space row |
Grouping actions and API | Actions, API events and methods for grouping |
|
Filtering rows | Showing only rows that satisfy filter condition, like in MS Excel simple filter |
Filter setting | Basic filter attributes |
Comparing strings | Case sensitivity, localized comparing, white characters |
User interface to choose filter | <Filter> row |
Filter actions and API | Actions, API events and methods for filtering |
|
Searching in rows and cells | Advanced filter or search like Google |
Search setting | Basic search attributes |
User interface for search | <Search> space row |
Search actions and API | Actions, API events and methods for searching |
|
Printing grid | Creating printable version of grid |
|
Export to Excel, CSV or PDF | Exporting cell values to XLS or CSV or printing to PDF |
Export to Excel | Basic export attributes for exporting to XLS or CSV, for both export types (client / server) |
Export to PDF | Basic export attributes for printing to PDF, server side export |
Export API | API methods and events for export |
Client export | Export generated by TreeGrid |
Server export | Export generated by user server script |
|
Copy & paste rows via clipboard | Copy & paste rows to and from MS Excel |
Copy & paste permissions | Attributes for both copy and pasting |
Copying to clipboard | Copying rows from grid to MS Excel via clipboard |
Pasting from clipboard | Copying rows from MS Excel to grid |
|
Master - detail grids | Master - detail relationship of two or more grids |
|
External objects | Using Flash, SilverLight and third-party JavaScript objects in cells |
|
Undo & Redo | Data manipulation changes can be undone and redone before they are saved |
|
Gantt chart |
|
Gantt objects | The Gantt bars and other objects that can be shown inside Gantt chart cell |
Edit settings | Attributes to set which Gantt objects and how can be changed |
Main bar | Planned task - one continuous bar, only one per row |
Milestone | Deadline - one icon, only one per row, instead of main bar |
Real Flow | Real process of planned task - one or more discrete bars with the same meaning |
Flag | Information for date(s) - one or more different icons with tooltip per row |
Point | Points in chart for date(s) or points in point charts |
Mark | Mark line, e.g. actual date - one or more vertical lines per row |
Gantt display and zoom | Global column settings for displaying Gantt chart |
Gantt column header | One or more lines in header displaying dates |
Background | Marks workdays, weekends or any other dates – for all rows the same |
Zoom options | Attributes to control unit size and rounding for whole Gantt chart column |
Zoom selection | Attributes to specify and change zoom level for whole Gantt chart column |
Gantt compute | Features for project management |
Data units | Base units for calculations and duration |
Defining dependencies | Dependencies between tasks - lines and arrows between main bars, milestones, run or flow |
Correcting dependencies | Automatic or manual correcting dependencies after any change |
Algorithm for correcting dependencies | How the correcting dependencies exactly works |
Project date constraints | Checking and setting base line and finish line of the whole project |
Task date constraints | Checking and setting task date constraints |
Exclude - holidays | Ignores or hides non workdays, non working hours or any other dates – for all rows the same |
Critical path - Slack (Float) | Calculates task slacks and builds critical path |
Summary tasks | Group summary tasks, including dependencies and constraints |
Gantt resources | Features for resources management |
Resources list | Global resources definition |
Resources assign | Assigning resources to individual tasks |
Resources filter | Filtering tasks according to assigned resources |
Resources calculations | Calculating task prices and resource allocation |
Resource usage chart | Showing resource allocation in chart |
Generated resource usage chart | Automatic generating resources usage chart from another Gantt chart |
Gantt popup menu | Gantt popup menu with available actions for the cell |
Gantt API | API events and methods to extend Gantt chart features by custom JavaScript code |
|
Run chart | More independent boxes in one cell, usable for service or resource management |
Run defintion | Attributes to define Run objects |
Run moving and resizing | Many ways of changing size and position of the individual Run bars |
Run API | API functions and events to manipulate the boxes by JavaScript |
Run actions | XML actions that can be used for Run and attached to some events |
Run formulas | Formulas specific for Run |
|
Line and XY points charts |
|
Line chart and XY points chart | Showing line and XY points chart in grid cell or in any HTML tag |
Charts in grid cells | How to define and display charts in TreeGrid space cell |
Chart JSON defintion | JSON structure of the chart definition |
Base chart settings | TLineChart object definition |
Basic attributes | Basic TLineChart attributes |
Size | Size and constraints of the whole chart |
Axis and caption | X,Y axis, labels and chart caption |
Individual chart lines | TChartLine objects defintion |
Data sources | Defining points and chart type |
Visual settings | Line width, colors and interpolation |
API for standalone usage | How to create chart from JavaScript |
|
Paging in grid |
|
Paging root rows | Splitting root (not child) rows into pages and pager types |
Paging types and attributes | Specifying client or server paging and other paging attributes |
Right side pager | Main page with all page names displayed on grid right side |
Pager with navigation buttons and edit | Cell type Pager (first,prev,next,last page buttons and edit page number cell) |
Pager as list of page indexes | Cell type Pages with links to all or selected pages |
API for paging | API events and methods to control paging |
|
Paging in tree | Background rendering of child rows |
ChildPaging | Download or render children on expand |
MaxChildren | Limit children count |
ChildParts | Rendering only visible children parts on scroll |
|
Server paging | Paging done on server, loading pages from server |
Server paging for root rows | Attributes for Paging='3' |
Server communication in root paging | How to implement server root paging |
Root paging in very large tables | How to show grids with more than 250,000 root rows |
Server paging in tree | Attributes for ChildPaging='3' |
Server communication in tree paging | How to implement server tree paging |
XML Request for Data in server root paging | XML structure in request for page list sent to server |
XML Download Data in server root paging | XML structure in server response with page list |
XML Request for Page or childreng | XML structure in request for page or row children sent to server |
XML Download Page or children | XML structure in server response with Page data or children rows |
API for server paging | API events and methods for server root paging and paging in tree |
|
TreeGrid server DLL/SO | Server side support DLL/SO for server paging |
Compatibility with TreeGrid component | List of not supported features of original TreeGrid |
Using TreeGrid server DLL/SO | How to call the DLL/SO functions from server script |
ASP.NET C# | Function definitions for C# |
ASP.NET VB | Function definitions for Visual Basic .NET |
PHP | Function definitions for PHP |
JSP Java | Function definitions for JAVA Server pages |
TreeGrid server concepts | How to create, delete and use TreeGrid server instances |
Function reference | Complete reference of all TreeGrid server functions |
Calculations | Calculations and formulas differences between TreeGrid and server DLL |
|
Popup menus and dialogs |
|
Menus | TreeGrid menu system, can be used also without TreeGrid |
Menu description | Basic TreeGrid library menu description |
JSON menu definition | TreeGrid menus use JSON format instead of XML |
Menu settings | Settings for whole menu (TMenu object) |
Base attributes | Base attributes |
Visual settings | Visual settings |
Key navigation | Key navigation |
Behavior | Behavior |
Size and scroll | Size and scroll |
Item settings | Settings for individual menu items (TMenuItem object) |
Base attributes | Base attributes |
Clickable item | Normal item that can be chosen and menu is closed |
Inactive caption | Item that does not respond to mouse and key actions |
Collapsible sub level | Item showing / hiding its child items on mouse hover |
Popup sub menu | Item showing its child items as next menu |
Columns | Item showing its child items in more columns |
Bool item | Checkbox or Radio item that can contain 0 or 1 value |
Enum item | Combobox item contains one selected value from popup list |
Edit item | Input item contains entered text |
Custom menu in JavaScript | Showing custom menu by JavaScript, even without TreeGrid |
Custom menu position | Where the menu will be shown |
Custom menu advanced settings | Advanced settings for JavaScript menus not used from TreeGrid |
Custom menu JavaScript events | Controlling menu by JavaScript callbacks |
Calendar dialog | Date picker dialog for choosing date or date ranges |
Custom calendar and JavaScript events | Showing custom calendar by JavaScript, even without TreeGrid |
Custom dialog in JavaScript | Showing any HTML dialog by API |
|
Global grid settings |
|
Grid size and scroll | Specifying grid size, resizing and scroll types |
Default behavior | Default grid size and scroll settings |
Maximize grid height and width | Resize grid to fill its main tag or the rest of page |
Update size according to the content | Turn off grid scrolling for small or all grids and resize main tag |
Let a user to control the grid size | Show resizing button on bottom right corner |
Widths of individual sections | How and when are shown horizontal scrollbars |
Other scrolling attributes and API | The rest of settings |
|
Grid cursor look - hover & focus | Specifies look of cell and row under mouse and focused cell and row |
|
Grid cursor - Focused cell and row | Focused cell and row and key navigation |
Focused cell and row | Specifies focused cell and row and focusing permitions |
Tabulator navigation | How to control navigation in grid by TAB key |
Key navigation | How to control navigation in grid by arrow and PgDn/PgUp/Home/End and other keys |
|
Global settings | Messages, configuration menu, default toolbar and language settings |
Status messages | Which status messages will be shown |
Configuration menu | Which items will be shown in grid cofiguration menu |
Default toolbar | Predefined buttons on default grid toolbar and how to hide them |
Language and regional settings (Text.xml) | How to translate and localize grid to other languages |
Useful API function | Global API functions for various use |
Help file | TreeGrid user help file |
|
Grid configuration in cookies | Many TreeGrid user settings can be restored from cookies |
|
Events and actions | Global key and mouse action schema (<Actions> tag) |
List of event handler types in TreeGrid | JavaScript callbacks - mouse, key, API, formulas and global event handlers |
TreeGrid mouse events | How to handle mouse events in <Actions> tag - mouse action schema |
Mouse event names | Base names of mouse events |
Key and mouse button prefixes | Prefixes for the event names according to the pressed key or button |
Touch event names | Events available for touch screens, especially for Apple iPad |
Event targets | Hierarchy of items in grid raising the mouse events |
Assiging event actions / callbacks | How to assing the handlers in XML and JavaScript |
Calling predefined actions from JavaScript | How to call the standard TreeGrid events from JavaScript code |
Focused vs. Actual cell | The difference between TreeGrid cursor and cell under mouse cursor |
TreeGrid key events | How to handle key events in <Actions> tag - key action schema |
JavaScript API events | Global API events attached to Grids array |
|
Mouse API | API events for mouse, like OnClick or OnMouseOver |
|
CSS styles | Description of all CSS classes used by grid (Grid.css) |
|
TreeGrid files | Description of all files used by TreeGrid |
|
Debug window | Specifying debug information displayed during loading and usage |