TreeGrid v6.0
Documentation glossary
Any item in the documentation has this definition
<place> type Name (parameters) [default value] Specialty version .
Yellow XML attribute
Blue API property or method it is part of Extended API. The Extended API is not included in any component license and must be purchased apart!
Green Action or Formula
Where the item can be used or placed
There can be listed more places like <C><cell> - item is an attribute of column or cell.
<treegrid,bdo> Basic TreeGrid definition on HTML page, defines TreeGrid data sources. It can be used <treegrid> or <bdo> tag.
<Cfg> XML attribute of tag <Cfg> basic grid configuration
<C> XML attribute of tag <C> whole column setting
<C Panel> XML attribute of tag <C> or <Panel> whole column setting for column type Panel
<B> XML attribute of tag <B> settings of page
<Root> XML attribute of tag <Root> row setting of virtual root row as parent of all first level rows
<D> XML attribute of tag <D> row setting of default row
<I> XML attribute of tag <I> row setting of normal row within columns (Data, Header, Filter)
<Header> XML attribute of tag <I> or <Header> setting of Header row
<Filter> XML attribute of tag <I> or <Filter> setting of Filter row
<Space> XML attribute of tag <I> or <Space> setting of any Space row (row kinds Space, Group, Search, Toolbar)
<Group> XML attribute of tag <I>, <Space> or <Group> row settings special for grouping
<Search> XML attribute of tag <I>, <Space> or <Search> row settings special for searching
<Toolbar> XML attribute of tag <I>, <Space> or <Toolbar> settings of Toolbar row
<cell> XML attribute postfix of tag <I> setting of any row cell, set with column name as prefix (e.g <I Col1Visible=0/>)
<I cell> XML attribute postfix of tag <I> setting of any non Space cell (row kinds Data, Header, Filter).
<Header cell> XML attribute postfix of tag <I> or <Header> setting of Header cell
<Filter cell> XML attribute postfix of tag <I> or <Filter> setting of Filter cell
<Space cell> XML attribute postfix of tag <I> or <Space> setting of any Space cell (row kinds Space, Group, Search, Toolbar)
<Group cell> XML attribute postfix of tag <I>, <Space> or <Group> special setting of cell for grouping
<Search cell> XML attribute postfix of tag <I>, <Space> or <Search> special setting of cell for searching
<Lang> XML tag as child of tag <Lang> language dependent settings
<Format> XML attribute of tag <Format> language dependent settings for numbers and dates, <Lang><Format /></Lang>
<Changes> XML attribute of tag <Changes> Download changes from server
API variable JavaScript property of grid (TGrid object)
API method JavaScript method of grid (TGrid object)
API event JavaScript method of global Grids array called as callback for defined event (like event handler).
API TCol var. JavaScript property of column (TCol object), the object is accessible by grid.Cols array.
API TRow var. JavaScript property of row (TRow object)
global func. JavaScript global function (a method of window object)
global prop. JavaScript global property (a property of window or Grids object)
<Actions> Name of action called for defined event in <Actions> tag or in cell.
It can be called also from JavaScript as TGrid object method with prefix Action (e.g. grid.ActionSelectAll();)
<XML event> XML attribute name in tag <Actions> or in cell.
Special cell event name like OnFocus or OnChange or mentioned standard cell event like OnClick
formula The function can be called from expression in calculation Formula.
The standard type of item, it is not JavaScript variable type, but it is similar to standard type in languages like C++, C# or Java.
The sense of the type in XML is to more precisely define what is expected to get in the item it has not any other special meaning.
void In API: method does not return value or event does not expect return value
bool In XML: 0 or 1 (not true or false)
In API: any expression that can be converted to true or false
int Integer value, in API it should be Number type.
It can be also bit array every bit in the number has its own meaning and the value is sum of the bit values (1.bit=1, 2. bit=2, 3.bit=4, 4.bit=8, 5.bit=16, 6.bit=32, 7.bit=64, 8.bit=128, 9.bit=256, ...)
Examples of bit array: to set first, third and sixth bit set 1+4+32 = 37, to set second, third, fifth and tenth bit set 2+4+16+512 = 534.
string String value, in API it should be String type.
string[] In XML: one string with individual items separated with comma: One,Two,Three
In API: array of strings
string[*] In XML: one string with individual items separated by first character in the string the string starts with the separator: |One|Two|Three
The separator can be any Unicode character not included in any of the separated items.
string[][] In API: two dimensional array of strings
TCol In API: column object (not name)
TRow In API: row object
TGrid In API: grid object, all API events get it as the first parameter.
Name of the item.
It is always one word and contains only alphanumeric characters [a-zA-Z0-9].
It always starts with upper case letter (except item named id).
If action has stated ...F it means that there are two action names, one with and one without F suffix (e.g SelectRow and SelectRowF). The one without F uses actual cell (under mouse) and one with F uses focused cell. The focused version with F suffix is usually used for key events or as actions run from toolbar.
For any your custom attributes you should use names starting with lower case letter to avoid any name interference with actual or future TreeGrid item names.
But attention, the TreeGrid XML is parsed to standard HTML document, so you should avoid using also any HTML DOM attribute names in TreeGrid XML!
Here is listed a default value that the items has.
These default values are preset usually in Defaults.xml, but some of them are also set directly in TreeGrid code.
If the default value is not defined, the item has initially null or 0 or empty string according to its type.
(type1 name1, type2 name2 = defval, ... )
Parameters are used only for API methods and events as JavaScript function parameters,
The types are expected parameter types, similar to type.
The parameter are named just for lucidity, important is only the parameter order.
If the parameter is missing in call (only for API methods), it gets the value defval.
For actions there is information where the action is attached by default (in Defaults.xml) and restrictions to which events can be attached.
For API variable here can be information that the variable is read only.
For XML attributes here can be information that the attribute is saved to and loaded from cookies therefore can be ignored in XML and information how to avoid it.
For XML attributes here can be information that the attribute is uploaded to server.
For XML attributes here can be information that the attribute can be undone (supports Undo), when set <Cfg Undo=1/>.
For any item here can be information that it belongs to RTL (Persian right left version) version.
Last update done to the item
new 6.0 Item was released in the given version (the item did not exist in previous versions)
chg 6.0 Major update to item was done in the given version (the usage of the item was changed)
upd 6.0 Minor update to item was done in the given version (like new parameter added to function or new value added to bit array)
renamed 6.0 The item has been renamed in the given version (the old name is usually still usable, but deprecated)