Export to Excel

TreeGrid documentation

Export of grid data to MS Excel in xlsx or xhtml format, to csv, or any other format.
For IE9 and older IE versions it requires communication with server.
Other browsers can save the exported file directly or can send it also to server.

The xlsx export and direct saving without server access was added in 12.1 version.

In TreeGrid export menu it is possible to choose which columns or rows to export and set various export options.
See Configuration menu for basic settings or Export menu for special settings.

Changes for client export can be done also by <Media><M Media='Export' ... /><Media>.

Export types

Direct export (since 12.1)
The exported data are created on client and saved as xlsx, csv or xls file directly to disk.
It is fully done by TreeGrid. Not supported in IE9 and older.

Client export
The exported data are created on client as xlsx, csv or xls, sent to server for validation and returned back to client.
It is done by TreeGrid and needs very short server script to return the data back.
Used instead of direct export in IE9 and older.

Server export
To server is sent only configuration in XML or JSON and server generates the data and sends them back to client.
It is done by custom server script that must be written by developers using TreeGrid.
There can be used also TreeGrid.dll/so as support library to generate the exported data on server side, but it supports only old xls format.
Server export is often required for server paging and server child paging to avoid loading all data to client.

Basic settings

Basic definition of export to MS Excel XLSX, XLS, CSV or any other custom type. Shared by all export types (direct, client and server).
If and in which predefined format the export will be done. Case insensitive.
It is also file extension to save the report by, always lowercase.
Since 12.1 the values completely changed and replaced Export_Type.
Possible values: empty - no export, xlsx - (original binary Excel xlsx file), csv - comma or semicolon separated values, xls - (old xhtml file, for compatibility).
It can contain also any other value for custom export into this file format.
File name to save the export by. It is without extension, extension is set by ExportFormat.
The way of client export (or server export via TreeGrid.dll/so) to Excel, comma separated list of keywords, case insensitive.
Many of these options can be changed in configuration menu, if set ExportCols = 2.
Since 12.1 the default value changed, Indent was replaced by Outline.

Filtered	xlsx, csv, xls	export also filtered rows
HideFiltered	xlsx	(new 16.1) export filtered rows as hidden, only if not set Filtered.
Selected	xlsx, csv	(new 12.1) export only selected rows, columns or cells. In xlsx, if set FormulaEditing and not the NoFormula flag, the unused rows and columns are exported to xlsx too, but hidden. If selected some rows and some columns and selecting cells is not permitted, it exports only their intersection. If nothing is selected, exports focused rows, columns or cells.
Expanded	xlsx, csv, xls	export all rows expanded
Hidden	xlsx	export all columns, including hidden (Visible='0' CanExport='1'). (since 12.1) export also manually hidden rows (Visible='0' Hidden='1' CanExport='1').
Hide	xlsx	(new 12.1, with option Hidden only) Hidden columns (Visible='0') are exported as hidden. Manually hidden rows (Visible='0' Hidden='1') are exported as hidden.
HideGroupCols	xlsx	(new 16.1) exports all columns hidden by grouping as hidden.
Outline	xlsx, csv, xls	export tree as Excel outline, for csv adds new column with the outline as characters '#'
Indent	xlsx, csv, xls	indent levels in main column
Selection	xlsx	(new 15.0) export selected rows, columns and cells as Excel selection. If not set, the selected rows/columns/cels are colored by background color, except if set NoColor flag
Focus	xlsx	(new 15.0) export focused cell or range as Excel cursor.
FixedRows	xlsx	(new 12.1) freeze (anchor) head rows. Note, Excel does not support freezing foot rows.
FixedCols	xlsx	(new 12.1) freeze (anchor) left columns. Note, Excel does not support freezing right columns.
Empty	xlsx, csv, xls	(new 12.1) export empty cells as actual cells with empty string - overflowing text of preceding cells will be hidden, but the resulting xlsx file of large grids may be larger. Since 15.0 in csv exports empty cells as one space.
KeepHTML	xlsx, csv	(new 12.1) places HTML tags to export, does not convert them to Excel style in xlsx or does not remove them in csv.
EnumKeys	xlsx, csv	(new 12.1) for Enum and Radio type exports its keys, not values
TextType	xlsx	(new 12.1) preserves Text type for number values. Otherwise it converts type of number values to number type.
Strings	xls	store strings in file twice to preserve their type a spaces, set it if you want to export all strings as strings and not chosen by Excel.
Bool	xlsx, csv	(new 15.0) exports Bool type and Auto boolean as TRUE / FALSE to xlsx or as CSVBool to xls and csv.
Currency	xlsx, csv	(new 15.1) exports actual currency instead of "$" in number currency format.
Language	xlsx	(new 16.1) exports all date and some number formats in actual TreeGrid language and forces Excel to display this locale. It does not affect decimal and thousand separators!
Unsupported	xlsx	(new 12.1) exports also TreeGrid date and number formats that are not fully supported by Excel, the unsupported part is replaced by '?' (since 15.0 defined by <Lang><Format Unsupported="\?"/></Lang>). Otherwise, if not present, exports such dates as string.
StyleNumbers	xlsx	(new 15.0) converts numbers and dates to formatted strings, if the Format contains HTML. If not present, the HTML is just removed from the Format.
StyleRows	xlsx	(new 15.0) sets row attributes to the whole rows to style/format empty cells right to the exported table.
StyleCols	xlsx	(new 15.0) sets column attributes also to the whole columns to style/format empty cells below the exported table.
NoNextCols	xlsx	(new 15.0) hides all not used columns outside exported table
NoNextBorder	xlsx	(new 15.0) hides border in all not used rows and columns outside exported table
NoColor	xlsx,        xls	(new 14.0) does not export row/col/cell Color attribute and does not color selected cells and header.
NoStyle	xlsx	(new 15.0) does not export any row/col/cell style or border, exports only values or formulas.
NoSpan	xlsx,        xls	(new 15.0) does not export row and column span.
NoWrapBR	xlsx	(new 16.0) does not automatically force Wrap=1 for cells containing <br> in Html / EHtml type or LF in Lines type.
NoFormula	xlsx	(new 15.0) does not export editable formulas, exports the formula results in values.
NoHtmlPrefix	xlsx	(new 16.1) does not export HtmlPrefix and HtmlPostfix attributes, useful for import.
NoBOM	csv, xls	(new 15.0) does not add UTF8 "EFBBBF" BOM to beginning of xls / csv.
Size	xlsx,        xls	(new 15.0) preserves default font size and column width according to the style Size. If not set, it always exports the same column widths and font size regardless on the style Size - it can export different column widths than actually displayed.
ForceBorder	xlsx	(new 15.0) forces displaying default border between cells when set cell background color or colors header or selection
GMT	xlsx, csv, xls	(new 15.1) to export dates in GMT regardless on GMT attributes. It was default value prior 15.1. If not set, the GMT=0 dates are exported as displayed in TreeGrid (the xlsx will differ according to timezone where exported).
Dates	xls	export dates as strings only (useful for exporting Hijri dates).
Rtl	xlsx, csv, xls	(new 7.1) the columns will be exported in reversed order when the grid is in Rtl mode. Since 15.0 it switches xlsx to Rtl mode.
TreeGrid	xlsx	(new 16.1) exports TreeGrid id (TGid), grouping setting (TGGroup) and rows excluded from import (TGIgnoreRows) to the sheet names. Used for exporting xlsx that can be imported by ImportRows.
ColNames	xlsx	(new 16.1) exports all column names (TGCol_xxx) to the sheet names. Used for exporting xlsx that can be imported by ImportRows.
Defs	xlsx	(new 16.1) exports names of default rows in last hidden column named in sheet names as (TGCol__Def). Used for exporting xlsx that can be imported by ImportRows.
GroupRows	xlsx	(new 16.1) exports all group rows in TGIgnoreGroupRows sheet name. Used for exporting xlsx with complex grouping (not all rows have the same grouping level) that can be imported by ImportRows.
RangeComment	xlsx	(new 16.1) exports all Date and number Range values (with more items) in raw English format to the cell comment. Used also for exporting xlsx that can be imported by ImportRows.
FormatComment	xlsx	(new 16.1) exports all Date and number values in formats not available in Excel in raw English format to the cell comment. Used also for exporting xlsx that can be imported by ImportRows.
TipComment	xlsx	(new 16.1) exports all cell Tip attribute values to the cell comment. It does not read the Tip from default cell, row or column.

If and which menu will be shown before doing export.
0 - no menu
1 - menu with columns and rows to select which columns will be exported. Only columns and rows with CanExport='1' are listed.
2 - (new 6.7) menu with columns, rows and also with all options for export
3 - (new 15.1) shows the menu also if the grid shows imported xlsx
See Configuration menu for basic settings or Export menu for special settings.
For direct or client export. Set to 1 in server paging or child paging to download all rows to be exported.
Since 13.1 if set to 2 it downloads all rows also if ExportType contains flag Selected - useful if row selection is saved on server.
Be careful permitting this option, it will download all pages and optionally child pages, when used ExportType = Expanded.
Settings for exported comments in xlsx, comma separated attributes "left,top,width,height,show,background,border".
left, top is position of the comment relative to the right top edge of the cell, cannot be negative.
width, height is size of the comment window.
show is 0 to hide the comments on start, 1 to show all comments on start.
background is background color of the comment window, can be any HTML color.
border is border color of the comment window, can be any HTML color or 'none'.
Tip as comment is exported only if set flag "TipComment" in ExportType.
Comma separated ids of grids to export.
If set and exporting to xlsx, exports all given grids to one xlsx on separate sheets.
The main grid id must be listed too to be exported.
Users in export menu can choose options, columns and rows only for the main exported grid, other grids are exported with default options.
Sheet name in xlsx where this grid will be saved, useful when saving more grids to one xlsx.
If not set, the DefaultSheet from Lang Alert will be used if exporting the only grid or grid id will be used if exporting more grids by ExportGrids.
If the column will be exported. 0 - no, 1 - yes, if chosen in menu or is visible, 2 - not used (now works as 3), 3 - always, 4 - (new 15.0) always even if not selected and exporting selected only, 5 - (new 16.1) always but hidden (in xlsx) or like 4 in csv/xls.
6 - (new 16.1) always and visible (in xlsx) or like 4 in csv/xls.
By default Panel has 0 and other columns 1.
More changes for client export can be done also by <Media><M Media='Export' ... /><Media>.
If row will be exported to Excel.
0 - neither row, nor its children, 1 - yes, if chosen in menu or is visible, 2 - (new 11.0) only its children, 3 (new 12.1) always, 4 - (new 15.0) always even if not selected and exporting selected only, 5 - (new 16.1) always but hidden (in xlsx) or like 4 in csv/xls.
6 - (new 16.1) always and visible (in xlsx) or like 4 in csv/xls.
Space rows are never exported.
If the column or row is checked in the print and export menu. If not set, the item is checked according to its Visible and CanPrint/CanExport setting.
Since 15.0 for xlsx and csv it adds new first row with this text in its first cell. It is ignored if set FormulaEditing.
For xls it is HTML code added into Excel report between Excel header and TreeGrid table.
Since 15.0 for xlsx and csv it adds new last row with this text in its first cell.
For xls it is HTML code added into Excel report between exported TreeGrid table and enclosing </body> tag
Raw cell value used for export to Excel exported as EHtml type without Format.
Cell value used for export to Excel. It uses the same Type as Format as the cell value.
Called to get value for export. format (new 15.0) is the exported format, "xlsx", "xls" or "csv".

If called from xlsx export, the format is set to "xlsx" and the str is html value to be exported as the cell value in xlsx. Return new str value for export or null to export original str.

If called from csv export, the format is set to "csv" and the str is html value that will be exported to csv, without the html tags. Return new value for export or null to export original str.

If called from xls export, the format is set to "xls" and the str is html tag ending character ('>'), so to return just string return str+your_value and to return formatted number return your_format+str+your_value.
For example: Grids.OnGetExportValue = function(G,row,col,str,format){ return " style='mso-number-format:\"$ 0.00\";'"+str+Get(row,col); }
TreeGrid date time or number format to be used instead of the cell Format for export to Excel.
See ExportFormat for number type or ExportFormat for date type.
From 12.1 to 14.1 it was not used for old xls export except for ExportType="Dates", it used XlsFormat instead.
Since 15.0 it is used for all exports, including xls and it is also read from row.
xlsx and old xls only.
Excel date time or number format to be used instead of the cell Format and ExportFormat for export to Excel.
It is exact MS Excel format string passed directly to xlsx format or to xls CSS attribute mso-number-format.
Since 15.0 it is used also for xlsx and it is also read from row.
Excel cannot easily display numbers with and without decimals by one format.
How to export formats containing ".#" to show optional decimals.
0 - export formats without change, the integer numbers will end by dot (or comma in some languages).
1 - change format in cells with integer numbers to be without decimals - if is edited such cell in Excel, it will never show the decimals until the format is manually changed.
2 - replace the number format by "General" and round the exported numbers to desired decimals count.
If set, the Float number will be rounded to this count of decimal digits.
csv and old xls only. First character separated list of three values for export in Bool type as "|0|1|empty". Used only if ExportType contains "Bool" flag.
Comma separated list of strings that will be exported instead of TreeGrid filter operator images.
Default value is ",= ,≠ ,< ,≤ ,> ,≥ ,|* ,|- ,*| ,-| ,*|* ,-|- " xlsx and old xls only. Html code to use when exporting the TreeGrid filter operator.
Can contain simple HTML code that can be exported to xlsx cell like <span style='color:...;font-size:...;font-weight:...;font-style:...;'>%1</span>.
Should contain %1 string to be replaced by actual operator string chosen from ExportFilters.
Default value is "<span style='color:red;'>%1</span>".
Excel hexadecimal language code, 0409 is US English.
Used when exporting date formats to xlsx with ExportType containing Language flag.

Styling export

Global and special styles for xlsx and xls export.
The CSS style added to the cell when exported.
For example to align the cell vertically to top, set ExportStyle='vertical-align:top'.

It can be used also to format the number or date value in Excel, e.g. ExportStyle='mso-number-format:"$ 0.00";' or ExportStyle='mso-number-format:"d.M.yyyy HH:mm";'
The Excel CSS attribute mso-number-format settings are similar to TreeGrid number and date formats.

In xlsx the permitted CSS attributes are exactly: mso-number-format, color, background-color, text-align, vertical-align, white-space, font-weight, font-style, font-variant, text-decoration, text-shadow, font-size, font-family, border, border-left, border-right, border-top, border-bottom. Colors and borders of exported cells.

HeaderColor	"#F5F5F5"	Color of header rows
HeadColor	""	(new 15.0) Color of head rows
FootColor	""	(new 15.0) Color of foot rows
LeftColor	""	(new 15.0) Color of left columns
RightColor	""	(new 15.0) Color of right columns
SelectedRowsColor	"#FFFFA6"	Color of selected rows
SelectedColsColor	"#FFFFA6"	Color of selected columns
SelectedCellsColor	"#F0F0A0"	Color of selected cells
AddedColor	"#D7FFD7"	(new 15.0) Color of added rows
DeletedColor	"#FFE5E4"	(new 15.0) Color of deleted rows
MovedColor	"#DAF3F2"	(new 15.0) Color of moved rows
ChangedColor	"#EBEBFF"	(new 15.0) Color of rows witch changed cells
ChangedCellColor	"#DADAEE"	(new 15.0) Color of changed cells
AlternateColor	"#FAFAFA"	(new 15.0) Alternate color for ExportAlternate
LinkColor	"#0563C1"	(new 15.0) Text color of cells with hyperlink
DefaultTextShadowColor		Deleted 15.0. Replaced by ExportTextShadow. Since 15.0 the TextShadow is exported as text color, not pattern.
DefaultTextShadowPattern		Deleted 15.0. Replaced by ExportTextShadow. Since 15.0 the TextShadow is exported as text color, not pattern.
TableBorder	"1,black"	Defines border around the table. Set it as "width,color". Since 15.0 it does not define border between sections (head, foot, left and right columns).
HeaderBorder	"1,gray"	Since 15.0 defines bottom border of the last Head row in Head section
HeadBorder	"1,gray"	Since 15.0 defines bottom border of head section
FootBorder	"1,gray"	Since 15.0 defines top border of foot section
LeftBorder	"1,gray"	Since 15.0 defines right border of the left columns section
RightBorder	"1,gray"	Since 15.0 defines left border of the right columns section
HeaderStyle	"bold"	Since 15.0 defines style of the header text, can contain comma separated flags "bold" and "italic"

For example: ExportOptions="{TableBorder:'2,gray'}" Highlight odd or every N row by another color in the exported xlsx / xls.
0 - no row, 1 - every row, 2 - every odd row, every third row, 3 - every fourth row, ...
If set to empty string it uses Alternate setting also for export.
Default Excel font size in every cell. In px, not in pt. Since 15.0 default value changed to 15.
Default Excel font name in every cell. The column width are multiplied by this value.
Use when ExportFontSize is bigger than TreeGrid font size to resize the columns to show the whole texts like in the grid.

XLSX export

Settings specific for direct or client export to xlsx.
Which images and how to export them, comma separated list of flags, case sensitive.

Img	exports images in Img attribute and in Img type.
Html	exports images in <img> tags in EHtml and Auto types.
Other	exports images in <img> tags in Html and Select types, HtmlPrefix, HtmlPostfix and Format.
Icon	exports images in Icon type.
Side	exports images in side Icon.
Panel	exports images in panel and does not export button names.
Button	exports images in side Button.
Bool	exports custom images in Bool type set in BoolIcon.
Space	Replaces the <img> tags in Html and Auto type by spaces, otherwise the text is shifted.
Indent	Indents the cell value when exported with side Icon or Button.
Resize	Attaches the images to two cells (top left and bottom right) and permits resizing the image between the cells. Requires synchronized row heights between grid and xlsx, usually by ExportHeights >= 3.

Images set by url (not by data:) cannot be exported when run locally on file:// protocol in IE.
Which links and how to export them, comma separated list of flags, case sensitive.

Link	exports links in Link attribute and in Link type.
Html	exports first <a> tag in EHtml and Auto types.
Other	exports first <a> tag in HtmlPrefix, HtmlPostfix and Format.
Underline	underlines all links

If set, it exports TextShadowColor as text color if the text has not defined the TextColor.
It can be set to color like "red" or "#FF0000" to use this color as TextColor for TextShadow without TextShadowColor set.
If not set, the TextShadow / TextShadowColor are not exported at all. Comma separated list of formula function names that cannot be exported to xlsx.
If formula contains any of these names, it is not exported to xlsx, the cell is exported only with its values.
Replaced by ExportHeights
0 - All rows are exported with single line height. Similar to ExportHeights='2'.
1 - Calculates height of cells in columns with VarHeight>=1, row height is set to the highest cell height. Similar to ExportHeights='3'.
2 - Like 1 and also ignores row MaxHeight attribute to export the whole content of all multiline cells. Similar to ExportHeights='4'.
If and how the row heights are exported.
0 - No height; all the row heights will be calculated by Excel according to the cell content. Default row height with only empty or single line cells is calculated according to the ExportFontSize.
1 - Set height; Only heights set by row Height attribute. Rows without Height set will be calculated by Excel.
2 - Default height; All rows will be exported with default height, set by row Height or ExportRowHeight or MinRowHeight or actual CSS style height.
3 - Actual height; All rows will be exported with actual height used in TreeGrid. For not rendered rows the height is calculated, so this option can slow down export if the grid has many not rendered page or child pages.
4 - Calculated height without MaxHeight; Like 3, but ignores MaxHeight attribute to export the whole content of multiline cells. It calculates height of all rows, so this option can slow down the export if the grid contains many rows!
Since 16.0 Default value is 3 for exporting Gantt charts and 1 for exporting grids.
Default row height for export to xlsx. If not set, default row height in actual CSS style is used.
Called when exporting one row to xlsx.
row is the source row being exported.
exrow is the object containing all row attributes and cell values and attributes that will be exported.
exrow does not have Def attribute, it has set all its attributes directly.
It is possible to modify the exrow to change the exported row.
Called when exporting one cell to xlsx.
row, col is the source cell being exported.
exrow, excol is the cell that contains value and attributes that will be exported.
exrow does not have Def attribute, it has set all its attributes directly.
It is possible to modify the exrow to change the exported cell, like exrow[excol] = "new value" or exrow[excol+"Tip"] = "new comment".
Called when exporting one column to xlsx.
column is the source column object (not name) being exported.
excolumn is the object containing all column attributes that will be exported.
It is possible to modify the excolumn to change the exported column.
If third party library JSZip will be loaded and used by TreeGrid.

JSZip is library for LZ compression. It is independent on TreeGrid. It is distributed under MIT or GPLv3 license.
It can be downloaded or its licensing read at https://stuk.github.io/jszip/

It is loaded by TreeGrid only for client export to xlsx and import of xlsx.
To not use it at all, set <Cfg JSZip='0'/>, in this case the export will produce longer uncompressed xlsx files, but xlsx import will be unavailable at all.
Zip compression level for xlsx files produced by JSZip.
0 - store (not compress), 1 - the fastest compression, ... 9 - the smallest size.
Ignored when exporting imported xlsx file.
If the xlsx file is uploaded to server in base64 or in blob.
Set it only if you use custom export in OnExport API event to get appropriate data format.
Default value is 1 if Export_Type is "Export" or "Save" or it is run on IE9 and older, otherwise it is 0.

Gantt export

Settings specific for exporting Gantt chart to xlsx.

Exporting Gantt chart is provided only with SpreadSheet component!

Style of Gantt objects, backgrounds, border, text properties, shapes, etc. are defined in <GanttExport> root tag in Defaults.xml/js.
The values of the GanttExport attributes are in format of xlsx OOXML, not CSS or JavaScript. To permit exporting Gantt chart to xlsx set CanExport='1' to the Gantt column. Comma separated list of all Gantt objects to export, case insensitive.
The order of exported the Gantt objects. The objects exported later will overlay the previous objects in the same place.
The not listed Gantt objects are never rendered.
If not set (by default), the GanttOrder is used.
Possible keywords to use: Availability, Constraints, Run, Main, Mark, Flags, Points.
It can contain also the next main bars keywords Main1, Main2, Main3, ..., Main10. If missing, these keywords are automatically added after Main keyword if increased GanttCount.
Unlike the GanttOrder it cannot contain Chart and Dependency. Chart is never exported and dependencies are exported always above other Gantt objects.
If dependencies are exported to xlsx. Dependencies are always exported above other Gantt objects. If and how the Gantt background is exported to xlsx, bit array.
1. bit &1 - if exports GanttLines, GanttBase and GanttFinish.
2. bit &2 - if exports GanttExclude.
3. bit &4 - if exports GanttBackground.
GanttUnits units for export. For every GanttExportUnits will be created xlsx column.
If not set, it is chosen as the smallest units in all GanttHeader.
If it is bigger than GanttHeader units, the header is not exported correctly. GanttWidth for exporting to xlsx. If set GanttSmoothZoom it is used only if it is higher than the GanttWidth.
List of all custom images used in Gantt chart for milestones and flags. If the custom Gantt image is not listed here, it is not exported..
First character separated list as "|image_url1|width1,height1|image_url2|width2,height2|image_url3...".
For example: Images="|Green.svg||Red.svg||Yellow.svg". If and how the Gantt column cells will be spanned in export. Bit array.
1. bit &1 - If set, all the cells will be spanned horizontally, the whole Gantt column will be one cell per row. If not set, every GanttExportUnits date will be one cell, the cells will have side border.
2. bit &2 - If set, removes the row border between cells in Gantt column.

CSV export

Settings specific for direct or client export to csv.
String or character that separates individual values in export to CSV
String or character that separates individual rows in export to CSV
Character that quotes value in export to CSV, if it contains one of the ValueSeparator, RowSeparator or Quote.
The quote characters are doubled in the value.
String or character to show level deep, when ExportType='Outline'
Format for all dates exported to CSV.
0 - Dates are exported as Excel numbers (count of days since 1/1/1900).
1 - Dates are exported as they are shown in grid, in display Format.
2 - Dates are exported in editable format.
string - Dates are exported in given date format.
Since 15.0 the default value changed to 1.
Format for all numbers exported to CSV.
0 - Numbers are exported as unformatted numbers with dot as decimal separator.
1 - Numbers are exported as they are shown in grid, in display Format.
2 - Numbers are exported in editable format.
string - Numbers are exported in given number format.

Old XLS / XHTML export

Settings specific for direct or client export to xhtml or for export to xhtml created by TreeGrid DLL/so.
Since 15.0 the xls export is also synchronous without progress bar.

Export API

Creates report in XLSX, XLS or CSV or a request for the server report and saves it to disk or sends it to server.
Called before the export menu is shown and the export report is generated.
(since 7.0) pdf is true for export to PDF
Return true to cancel export.
Called after the options are chosen by a user in menu and before the export is generated.
Cols is array of all columns to export, by column name. If the column is not listed, it is not exported.
Rows is array of rows to export, by row id. If the row is not listed, it is exported according to its CanExport value.
It is possible to modify these arrays.
Other settings like ExportFormat or ExportType are already read from configuration and can be modified in the grid attributes.
source is data source used, can be null for direct save or grid.Source.Export for export, or grid.Source.ExportPDF for PDF export.
Can be used for custom export or export to different formats.
Return true to cancel export.
Called after the export or configuration is created and before it is saved to disk or sent to server.
data is the created export or configuration. It can be string or (since 12.1) Blob object. Since 15.1 controlled by ExportBase64 attribute.
(since 12.1) type is data type: 0 export configuration, 1 export pdf configuration, 2 direct data to save, 3 direct data to send to server, 4 (since 15.1) direct data to send to server for save.
Return true to suppress the export.
Or return new or updated data to send.
Saves exported data to file (source = null) or sends it to server to source like grid.Source.Export or grid.Source.ExportPDF.
Sends the data to server as export or configuration.
Since 12.1 is does not call OnExport.

Communication with server

By default (Export_Type="") the server communication is required only for IE9 and older browsers.
If and what will be sent to server for export, case insensitive.

Direct export (since 12.1)

empty
In all browsers except IE9 and below will be sent nothing to server; the generated file will be saved directly.
Only in IE9 and below will be sent to server full report in XLSX/CSV/XLS format (chosen by ExportFormat).

Client export

Export
To server will be sent full report in XLSX/CSV/XLS format (chosen by ExportFormat).
Prior 12.1 the client export was always sent to server, using keywords "xls" or "csv"

Save (new 15.1)
To server will be sent by AJAX full report in XLSX/CSV/XLS format (chosen by ExportFormat).
Nothing will be downloaded.

Server export

Settings
To server will be sent only configuration (sorting, grouping, filters) and columns (positions, visibility and widths) in XML.
The server must generate the requested report in XLSX, XLS or CSV according to the settings and stored data and return it to client.
See Server export.

Expanded
Sends ids of all expanded rows in <Cfg Expanded/> attribute, comma separated.

Changes
Used usually with Settings for server export.
Sends modified rows - rows with set attribute Added, Deleted, Moved or Changed (modified values). The rows are sent in <Changes> tag.
When set, the export does not save the changes to server before export, but includes them in the export request.

This attribute supports for server export also all other settings like Cookie or Data defined for _Type, see Upload_Type. Also Export_Flags are supported if defined, see Upload_Flags.
If set Export_Type="" (default value), it is required only for compatibility with IE9 and older IE browsers.
Destination for page that generates data to export to XLSX, XLS, CSV or any other format.
This server URL should return the exported data as XLSX / XLS file in HTTP content-type="application/vnd.ms-excel" or CSV as "text/csv".
This communication is not done by AJAX, but always by hidden form, so it can be used even if no ActiveX is supported.
Export cannot use Soap or Get communication.
If you encounter problems with export of international (non-English) characters, add to your page, to <head> section:

In client export (Export_Type='' or 'Export') to this URL is uploaded complete exported data and the server script should just return them back.
In server export (Export_Type='Settings' or other value) to this URL is uploaded actual grid configuration and the server script should create and return the exported data by itself.
The name of form input in that will be uploaded exported data or configuration to Export_Url.

Client export

By default (Export_Type="") the server communication is required only for IE9 and older browsers.

To server (to Export_Url) is sent whole prepared report that can just be returned by this page back to Excel.
The uploaded data can be plain text (for xls and csv) or base64 encoded for binary xlsx.
In "custom" parameter "ExportFormat" is sent chosen file extension "xlsx", "xls" or "csv".
In "custom" parameter "ExportName" is sent chosen file name.
Should be used only for small grids, because to server are send all data back.
Cannot be used with server paging or server child paging.
Space rows are not exported.
The server script just returns the data from Data attribute back to client with changed content type.
For MS Excel use ContentType="application/vnd.ms-excel" and charset: utf-8.

Examples of server script for client export

Point Export_Url to simple server script that will just return the received data:

ASP.NET
<%@ Page Language="C#" ContentType="application/vnd.ms-excel" %>
<% Response.AppendHeader("Content-Disposition","attachment; filename=\""+Request["ExportName"])+"."+Request["ExportFormat"]+"\"");
Response.AppendHeader("Cache-Control","max-age=1, must-revalidate");
string data = Request["Data"]; if(data==null) data = "";
if (data.IndexOf('>') >= 0 || data.IndexOf("<") >= 0 || data == "") Response.Write(HttpUtility.HtmlDecode(data));
else Response.BinaryWrite(Convert.FromBase64String(data)); %>

JSP
<%@page contentType="application/vnd.ms-excel"%><%@page pageEncoding="UTF-8"%><%
request.setCharacterEncoding("utf-8");
response.addHeader("Content-Disposition","attachment; filename=\""+request.getParameter("ExportName")+"."+request.getParameter("ExportFormat")+"\"");
response.addHeader("Cache-Control","max-age=1, must-revalidate");
String XML = request.getParameter("Data"); if(XML==null) XML = "";
if(XML.length()>0&&XML.charAt(0)=='&') XML = XML.replaceAll("<","<").replaceAll(">",">").replaceAll("&","&").replaceAll(""","\"").replaceAll("'","'");
if(XML.indexOf("<")>=0) out.print(XML);
else {
java.io.BufferedOutputStream O = new java.io.BufferedOutputStream(response.getOutputStream());
O.write(javax.xml.bind.DatatypeConverter.parseBase64Binary(XML)); O.flush(); O.close();
} %>

PHP
<?php
header("Content-Type: application/vnd.ms-excel; charset=utf-8");
header("Content-Disposition: attachment; filename=\"" . $_REQUEST["ExportName"] . "." . $_REQUEST["ExportFormat"] . "\"");
header("Cache-Control: max-age=1; must-revalidate");
$XML = get_magic_quotes_gpc() ? stripslashes($_REQUEST["Data"]) : $_REQUEST["Data"];
if(strpos($XML,"<")===false || strpos($XML,"<")===false) echo(base64_decode($XML));
else echo html_entity_decode($XML); ?>

Any other language can generate the export similarly.

Server export

To server is sent just actual grid configuration – sorting, grouping, filters, search and column width, positions and visibility.
In "custom" parameter "ExportFormat" is sent chosen file extension "xlsx", "xls" or "csv".
In "custom" parameter "ExportName" is sent chosen file name.
In "custom" parameter "ExportType" is sent chosen ExportType flags.
For Export_Type="Settings", "Cols" or "Hidden", the rows and column are marked as visible if they were checked in export menu.

It is possible to upload also other data from client like changes, set Export_Type="Settings,Changes".
The configuration is sent as standard TreeGrid XML in Data attribute.
Server must generate the report from data on server by itself and return report to client.
Use this way for larger grid and/or for grids with server paging or server child paging.
Use it also if you want to generate different then standard report or you want to generate report for another program then MS Excel.

XML structure of request for server export

Used as request sent to data source Export to get the exported grid when set server side export (Export_Type="Settings").
It contains session identification and grid configuration to sort, group, filter and search exported data on server.
It contains also columns settings - width, position and visibility.

<Grid>

</Grid>