Configuration in cookies

TreeGrid documentation

Many TreeGrid settings are automatically saved in client browser and are persistent between sessions. So the server does not need to care about it.
The saved settings override the settings in xml, so the settings in xml are used only for the first visit, when no settings are saved in cookies.
When the grid layout is changed, you should increase Version attribute to delete old configuration from cookies and use the new setting from xml.
Since 6.4 the Version is automatically generated because of setting AutoVersion='1'.
You can suppress saving configuration completely by SuppressCfg='3' or you can suppress only some setting by appropriate ...Lap attribute (for example SortLap='1' suppresses only sorting).
Configuration is saved under the grid id name. Grids with the same id will share their saved settings, but only if cookie or persistent storage is shared between those pages.
You can control cookie setting also by API properties Grids.CookieExpires and Grids.CookieParam.

The settings are saved to cookies by default. Because of cookies size limit (4096 B) you can save it to browser persistent storage instead. The persistent storage is supported only by IE 5.0+ and Firefox 2.0+. See PersistentCfg attribute.

It is also possible to upload to and download from server the actual configuration in XML (Upload_Type="Settings") or in black box Cookie (Upload_Type="Cookie").

To cookies (or persistent storage) is saved by default

• Columns' visibility, positions and widths
  Attributes <C Visible>, <C Width> and positions of tags <C> inside their section
  
  
• Column sections widths
  Attributes <Cfg LeftWidth MidWidth RightWidth/>
  
  
• Sort, filter, group and search settings
  <Cfg Sort AutoSort Sorted/>
  <Cfg Group Grouped/>
  <Cfg SearchExpression SearchAction SearchMethod SearchCaseSensitive SearchCells SearchDefs SearchCols Searched/>
  <Filter> cell values and cell Filter attribute and <Cfg Filtered/> attribute.
  
  
• Configuration settings - set in configuration menu and from toolbar
  <Cfg ShowDeleted Calculated AutoUpdate ShowDrag AllPages Hover SortIcons CustomScroll ScrollAction/>
  
  
• Width and height of main tag if grid resizing is permitted (css style height and width of the main tag).
  
  
• Export settings
  <Cfg ExportType, ExportFormat />
  
  
• Printing and PDF Export settings
  <Cfg PDFPageSize, PDFPageOrientation, PDFFitPage, PDFText, PrintExpanded, PrintFiltered, PrintPageBreaks, PrintRows />
  
  
• Gantt chart settings - attributes of Gantt type column
  From menu: GanttCorrectDependencies, GanttCheckDependencies, GanttCorrectDependenciesFixed, GanttFixComplete, GanttStrict,
  

  GanttHideExclude, GanttBaseProof, GanttFinishProof, GanttBasePreferred, GanttFinishPreferred, GanttCheck, GanttCheckExclude
  GanttMinSlack, GanttErrSlack, GanttSeparateSlack
  

  Zoom: GanttZoom, GanttWidth, GanttDate
  Other: GanttResourcesFilter
  
  

For grids with more columns to decrease cookie size of saved data, you should name columns as short as possible, the best to up to three characters.

To cookies (or persistent storage) you can also save:

• Scroll left and top (permit it by ScrollLeftLap='0' / ScrollTopLap='0')
• All shown / hidden row state (row Visible attribute) (permit it by SaveVisible)
• All expanded / collapsed state in tree (row Expanded attribute) (permit it by SaveExpanded)
• All expanded cells (permitted by ExpandCells or ExpandRows)
• All selected rows state (row Selected attribute) (permit it by SaveSelected)
• All pending changes (changed cell values, added, deleted, moved rows) (permit it by SaveValues)
• Custom filters (permit it by SaveFilters)
• Server session (IO Session attribute) (permit it by SaveSession)
• Chosen grid style (<Cfg Style/>)

Take care about the length of saved data, especially if you are saving to cookies and not to persistent storage. You can usually permit saving of these setting only for small grids.
Unique ID of created TreeGrid on the page. It must be string, not number, to not collide with grid indexes.
Under this name will be stored configuration to cookies or persistent storage if not set CfgId.
Under this name will be stored configuration to cookies.
Useful to set when more grids on page share the same configuration.
Version of data. Grid loads configuration from cookies only if the Version is the same as saved.
Change this number whenever data structure (especially number of columns, column names and types) changes to delete old configuration saved to cookies.
Since 6.4 the not set Version is automatically generated when set AutoVersion='1' (it is set by default)
If set to 1, the configuration Version is automatically generated according to the actual values in XML layout.
Whenever is the XML layout changed (only the attributes saved to cookies), the whole cookie is cleared and new values from XML are used.
If set Version or Cookie attribute, the AutoVersion is ignored.
The XML attributes ignored in AutoVersion calculation: values (SaveValues), Selected (SaveSelected), Expanded (SaveExpanded), main tag width, scroll position.
Remember, when upgrading TreeGrid to higher version, there are often added new items to cookie, so in this case the Version changes and the old configuration is cleared when set AutoVersion='1'.
If does not use any client settings in cookies (0 - uses, 1 - does not load, 2 - does not save, 3 - nothing)
If set to 4 does not load or save configuration from cookies, but still accepts and returns configuration in Cookie attribute.
It is good to set SuppressCfg='1' for development.
Which default configuration is saved to be available to be restored by RestoreCfg
1 - default configuration in XML
2 - configuration loaded from cookies on start
3 - both
Controls Defaults button in configuration menu.
0 - button will be hidden
1 - button loads default configuration in XML (must be set DefaultCfg to 1 or 3)
2 - button loads configuration loaded from cookies on start (must be set DefaultCfg to 2 or 3)
If set, uses persistent browser cache instead of cookies for saving configuration.
The persistent cache can store much more data, at least one megabyte (shared among all pages).
(Since 7.0) This persistent cache is used as localStorage in IE8+, Firefox 3.0+, Chrome 4+, Safari 4+, Opera 10.5; Maximal capacity 5MB
IE6 and IE7 uses userData behavior with maximal capacity 128kB
Firefox 2.0 uses globalStorage with maximal capacity 1 MB
In many browsers the persistent cache is not used when running locally on protocol file://.
0 - use cookies, 1 - use persistent cache if available otherwise use cookies, 2 - use only persistent cache, if available, 3 - (new 11.0) use sessionStorage if available
Comma separated array of pairs [ident, attribute_name], like "ident1,attr1,ident2,attr2,ident3,attr3,...".
The ident can be: a) row id to save row attribute, b) since 8.0 column name to save column attribute or c) empty to save <Cfg> attribute.
In case the column name collides with row id, the column is used.
Since 14.1 the ident can be keyword starting by asterisk: *Col to save attribute of all columns, *Row to save attribute of all rows, *Fixed to save attribute of all fixed rows (head+foot), *Space to save attribute of all solid space rows.
Saves all these attribute/cell values to cookies. To save cell value, just specify its column name (as even value and row id as ident).
You can also save any your custom row, column or grid/Cfg attribute.
For example "R1,Col1,R6,Col7CanEdit,Col1,CanEdit,,Adding" = saves values R1.Col1 and R6.Col7CanEdit, column Col1 attribute CanEdit and Cfg.Adding
! Remember, the configuration from cookies is loaded after layout xml (if present) is loaded, so to save attributes from rows loaded in data xml is impossible !
By default are all values saved by SaveAttrs trimmed to 50 characters, because the size of cookie is small, you can change the predefined length here.
Whole configuration in string as it was saved to cookie. Use this attribute to get or return configuration saved on server by Upload_Type="Cookie". If this attribute is set, the configuration is loaded from it instead of cookies.
Loading configuration is still affected by SuppressCfg (see also its value 4), Version and other such settings.
Remember, this setting must not be modified, it must be completely the same as the setting returned by grid when saving.
To send configuration to server by API you can use such code: AjaxCall ("url to send", grid.GetXmlData("Cookie"));
When configuration in cookies expires, 0 (default) never, 1 only this session, >1 after xxx seconds, or can be of type Date - exact expiration date.
Other cookie parameters (path, domain, secure) in string, starting with ';'. For example "; path=/".
Called when configuration is being loaded, return true to suppress loading. Called even if SuppressCfg set.
(new 8.0) cfg is cookie string that was passed to LoadCfg, if any.
Called after configuration is loaded to provide own update to cfg.
(new 8.0) cfg is cookie string that was passed to LoadCfg, if any.
Called when configuration is being saved to cookies, return true to suppress saving. Called even if SuppressCfg set.
(new 8.0) return is set to true if configuration is not saved to cookies, it is just read.
Called when TreeGrid cookie is to be saved to browser cookies or local storage, return true to suppress saving.
Here you can upload the cookie to server by AjaxCall to be later loaded to grid by Cookie attribute.
Called to load custom configuration saved by OnSaveCustomCfg.
The custom is the custom configuration string. Is null, if no custom configuration was saved.
cfg is cookie string that was passed to LoadCfg, if any.
Called to add any custom string to saved configuration. Return the string to add.
return is set to true if configuration is not saved to cookies, it is just read.
Loads configuration from cookies. Does not display any changes.
Since 8.0 it can be called also after grid is rendered to apply the configuration changes again.
Since 8.0 The cookie can be cookie string got by SaveCfg method or GetXmlData with Cookie setting.
Saves configuration to cookies.
Call it after some custom setting changed to save changes to cookies.
Since 8.0 If set return = true, it returns the configuration in string instead of saving it cookie. To be later used by LoadCfg or by Cookie attribute.
Reloads specified configuration saved by DefaultCfg
type = 1 - default configuration in XML, 2 - configuration loaded from cookies on start
Saves value to persistent cache according to given id. See PersistentCfg.
You can also redefine this function to do your own caching mechanism when set <Cfg PersistentCfg>.
(Since 11.0) If set session = 1, it saves to sessionStorage instead of localStorage.
Loads and returns value from persistent cache saved by SaveCache function.
(Since 11.0) If set session = 1, it loads from sessionStorage instead of localStorage.