This property determines whether a custom palette will be created or whether to use the standard Excel palette of colors when exporting.
A custom palette will make the exported Excel Workbook appear exactly like the exported grid. However, using a custom palette can cause problems when copying and pasting from one Excel Workbook to another. Since the two workbooks are unlikely to share exactly the same palette, colors may change.
Using the standard Excel palette means that the colors in the Excel Workbook will not exactly match those in the grid. For each color used by the grid, the closest matching color in the standard palette will be used in Excel. Copy and Paste using a Workbook creating using the Standard palette will not result in any color changes - unless the pasting is done onto a Workbook with a custom palette.
Note that the palette mode is determined by the WorkBook. So this property will only be used when the ExcelExport creates a new workbook. If a workbook is passed in to the Export method, then the palette mode of the Workbook is used. To change the palette mode of a Workbook created in code, pass a
When true (the default), the UltraGridExcelExport will attempt to convert grid formulas into equivalent formulas in the exported worksheet.
When false, the value of the cell in the grid at the time of the export will be exported directly to the value of the cells in the worksheet.
The exporting of formulas is done after all of the data in the grid has been exported. So when this property is set to true, the normal export process of exporting the values of the grid cells to the worksheet cells will still occur as normal, and the exporting of formulas will occur after all of the raw data exporting has completed.
Due to limitations of Excel and differences between Excel and UltraCalcManager behavior, some formulas may require the creation of a hidden worksheet which will point back to the main worksheet for it's data.
If the exporter fails to convert a formula for any reason, the
The Layout argument returns a reference to a cloned UltraGridLayout used for excel exporting. Any changes you make to this layout will be reflected in exported file and not in the original grid layout.
The Rows argument returns a reference to a original rows collection in top band.
Additionaly this event has Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired before all other events. You can use it to do any preprocessing before exporting process starts. For example, you can set properties on cloned layout or write some custom header to Excel workbook.
The Row argument returns a reference to a grid row which is being exported.
The SkipRow argument specifies whether to skip the current row. This argument doesn't affect exporting of descendant rows.
The SkipDescendants argument specifies whether to skip the descendats of the current row.
The SkipSiblings argument specifies whether to skip sibling rows of the current row.
The TerminateExport argument specifies whether to terminate the export process. Current row will not be processed.
Additionaly this event has Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired for every grid row which is being exported, and before
The GridRow argument returns a reference to row being exported.
Additionaly this event has Cancel, Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired before excel row with grid data is processed. Use Cancel argument to cancel row exporting. If grid rows spans multiple Excel rows (like in row layout mode), this event is fired only for first row.
The GridRow argument returns a reference to row being exported.
Additionaly this event has Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired after excel row with grid data is processed. Use it to apply any additional formatting to excel row. If grid rows spans multiple Excel rows (like in row layout mode), this event is fired only for last row.
The Summaries argument returns a reference to summary values.
The SummaryLevel argument returns a current summary level.
Additionaly this event has Cancel, Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired before excel row with summary values for specific level is processed. Use Cancel argument to cancel row exporting. If summaries span multiple Excel rows (like in row layout mode), this event is fired only for first row of summaries.
The Summaries argument returns a reference to summary values.
The SummaryLevel argument returns a current summary level.
Additionaly this event has Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired after excel row with summary values for specific level is processed. Use it to apply any additional formatting to excel row. If summaries span multiple Excel rows (like in row layout mode), this event is fired only for last row of summaries.
The Band argument returns a reference to UltraGridBand associated with headers.
The GridRow argument returns a reference to UltraGridRow associated with headers.
The HeaderType argument returns type of header.
Additionaly this event has Cancel, Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired before excel row with header values is processed. Use Cancel argument to cancel row exporting. If headers span multiple Excel rows (like in row layout mode), this event is fired only for first header row.
The Band argument returns a reference to UltraGridBand associated with headers.
The GridRow argument returns a reference to UltraGridRow associated with headers.
The HeaderType argument returns type of header.
Additionaly this event has Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired after excel row with header values is processed. Use it to apply any additional formatting to excel row. If headers span multiple Excel rows (like in row layout mode), this event is fired only for last header row.
The GridRow argument returns a reference to a grid row containing the cell.
The GridColumn argument returns a reference to associated grid column.
The Value argument returns a grid cell value.
Additionaly this event has Cancel, Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired before excel cell with grid data is processed. Use Cancel argument to cancel cell exporting.
The GridRow argument returns a reference to a grid row containing the cell.
The GridColumn argument returns a reference to associated grid column.
The Value argument returns a grid cell value.
Additionaly this event has Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired after excel cell with grid data is processed. Use it to apply any additional formatting to excel cell.
The GridHeader argument returns a reference to grid header.
The GridRow argument returns a reference to associated grid row.
The HeaderType argument returns header type.
Additionaly this event has Cancel, Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired before excel cell with header value is processed. Use Cancel argument to cancel cell exporting.
The GridHeader argument returns a reference to grid header.
The GridRow argument returns a reference to associated grid row.
The HeaderType argument returns header type.
Additionaly this event has Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired after excel cell with header value is processed. Use it to apply any additional formatting to excel cell.
The Summary argument returns a reference to a summary value.
The SummaryLevel argument returns current summary level.
Additionaly this event has Cancel, Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired before excel cell with summary value is processed. Use Cancel argument to cancel cell exporting.
The Summary argument returns a reference to a summary value.
The SummaryLevel argument returns current summary level.
Additionaly this event has Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired after excel cell with summary value is processed. Use it to apply any additional formatting to excel cell.
The Canceled argument is true if exporting process was been canceled.
This event has Workbook, CurrentWorksheet, CurrentRowIndex, CurrentColumnIndex, CurrentOutlineLevel arguments inherited from
This event is fired after exporting process is finished and is fired after all other events. Use this event for any post processing of excel workbook.
The FrameworkFormatStr argument has value only if column has format string assigned. Value represents format string in .NET Framework format.
If needed, the ExcelFormatStr argument should be set to excel specific format string. If not set, cells in column will have no specific format.
This event is fired when a grid column is initialized. You should use this event to convert format strings from .NET Framework format to Excel format. See .NET Framework documentation and Excel help file for more information about differences in format strings.
The FrameworkFormatStr argument has value only if summary has a DisplayFormat string assigned. This represents the format string in the .NET Framework format.
If needed, the ExcelFormatStr argument should be set to an Excel-specific format string. If not set, exported summaries will have no specific format.
This event is fired when a SummarySettings is initialized. You should use this event to convert format strings from .NET Framework format to Excel format. See .NET Framework documentation and Excel help file for more information about differences in format strings.