TreeGrid files
TreeGrid documentation
All required files are in one directory. In default distribution is this directory "
Grid\".
All files can be moved or renamed, but these changes must be registered. For every file is noted, where you have to do the changes.
By default you must preset location for main script file
GridE.js. All other files are by default searched in the same directory as
GridE.js.
The red files are required.
All files may be modified except
GridE.js.
GridE.js
Main JavaScript code. You must include reference to this file in <head> section on HTML page.
<script src="../Grid/GridE.js"> </script>
To ensure the newest script is loaded, add some version parameter to it like
<script src="../Grid/GridE.js?v11_0"> </script>
It is forbidden to modify this file!
Remember, all other required files are searched by default in the same directory as this file.
GridEOnDemand.js
JavaScript for loading main script file GridE.js only when it is required, to save time for downloading and running the long script.
Include this file instead of GridE.js if you want to download the script only on demand.
When you will want to create and show TreeGrids on your page, load GridE.js by calling the
LoadGridE (
path,
func) function.
The
path is url of GridE.js file like "../Grid/GridE.js". The
path can be relative to the main page url as usual or can be absolute.
For empty
path is used the path to the GridEOnDemand.js if exists.
Check the script path carefully, the most errors are caused because of wrong path.
The LoadGridE is asynchronous function, set
func to be called after the script is loaded.
Defaults.xml
Data source file with predefined values for all required TreeGrid parameters, for all grids.
This file should not be changed to avoid problems with upgrading to new TreeGrid version.
To predefine default values for all your grids use
Base data source.
Path and name and/or place you can change in <treegrid>/<bdo> attribute prefix
Defaults_.
This file can be loaded as static file or can be generated by web page or service or can be included in HTML page.
There is also
JSON version of the Defaults.xml located in /Examples/Html/BasicAjax/Defaults.js.
See the Defaults.xml content
Text.xml
Data source file with all TreeGrid texts and messages and language dependent constants for formatting numbers and dates.
Path and name and/or place you can change in <treegrid>/<bdo> attribute prefix
Text_.
This file can be loaded as static file or can be generated by web page or service or can be included in HTML page.
This file is for English language.
You can translate this file to any other languages and also return appropriate language file according to client browser settings.
There is also
JSON version of the Text.xml located in /Examples/Html/BasicAjax/Text.js.
See the Text.xml content
style_name/Grid.css style_name/Gantt.css
Cascade style sheets for TreeGrid.
Every available TreeGrid style has its own subdirectory in /Grid directory and here are the
Grid.css and
Gantt.css files.
The
Gantt.css is required only if used Gantt chart. The
Grid.css is required for both grid and Gantt.
These files reference all the other image files in the style subdirectory. These image files are
not accessed by TreeGrid script itself.
There are ten available styles now:
Standard,
Light,
Office,
Modern,
Borders,
Query,
ExtJS,
Robust,
Plain,
Colors.
Every style has its own class prefix, so more
Grid.css /
Gantt.css styles can be included to one page at once.
The actual style is set by
<Cfg Style='Modern'/> attribute.
If the Grid.css is moved, its path can be set by
<Cfg CSS='...'/>, relative to the actual page URL.
Only one style can be used by one grid at a time, but you can switch the styles at runtime. Also every grid on page can have its own style chosen.
All unused styles, their subdirectories, can be deleted if required.
How to change CSS styles is described in comments in the Grid.css and Gantt.css.
Drag.cur
Mouse cursor displayed when dragging row(s) or column(s).
The file must be placed in the same directory as GridE.js.
Can be redefined by <Cfg DragCursor/>.
Ding.wav
Beep played on error in EditMask when grid has set
<Cfg Silent='0'/>.
The file must be placed in the same directory as GridE.js.
Help.html
User help for TreeGrid. It is displayed after user clicks on
Help button at control panel.
Path and name you can change in input
XML data, in attribute
<Cfg HelpFile='...'/>.
Note, this file uses images from Modern style!