Back to Devexpress

IcxExportProgress Interface

vcl-cxexport-8570216e.md

latest11.1 KB
Original Source

IcxExportProgress Interface

Allows you to track the progress of an export operation and abort it if necessary.

Declaration

delphi
IcxExportProgress = interface(IcxProgress)

Remarks

You need to implement the IcxExportProgress interface and its OnProgress method in a handler object and pass it to one of the following data export methods as the optional AHandler parameter to track the progress of a data export operation:

VCL Data Grid Export Methods

ExportGridDataToCSVExports cell content of a data grid to a CSV (comma-separated values) file.ExportGridDataToCSVStreamExports cell content of a data grid to a stream in CSV (comma-separated values) format.ExportGridDataToExcelExports cell content of a data grid to a file in Microsoft Excel® binary format (XLS).ExportGridDataToExcelStreamExports cell content of a data grid to a stream in Microsoft Excel® binary format (XLS).ExportGridDataToHTMLExports cell content of a data grid to a file in HTML format.ExportGridDataToHTMLStreamExports cell content of a data grid to a stream in HTML format.ExportGridDataToTextExports cell content of a data grid to a file in plain text format.ExportGridDataToTextStreamExports cell content of a data grid to a stream in plain text format.ExportGridDataToXLSXExports cell content of a data grid to a file in Office Open XML spreadsheet format (XLSX).ExportGridDataToXLSXStreamExports cell content of a data grid to a stream in Office Open XML spreadsheet format (XLSX).ExportGridDataToXMLExports cell content of a data grid to a file in XML format.ExportGridDataToXMLStreamExports cell content of a data grid to a stream in XML format.ExportGridToCSVExports content of a data grid control to a file in CSV (comma-separated values) format.ExportGridToCSVStreamExports content of a data grid control to a stream in CSV (comma-separated values) format.ExportGridToExcelExports content of a data grid control to a file in Microsoft Excel® binary format (XLS).ExportGridToExcelStreamExports content of a data grid control to a stream in Microsoft Excel® binary Format (XLS).ExportGridToHTMLExports content of a data grid control to a file in HTML format.ExportGridToHTMLStreamExports content of a data grid control to a stream in HTML format.ExportGridToTextExports content of a data grid control to a file in plain text format.ExportGridToTextStreamExports content of a data grid control to a stream in plain text format.ExportGridToXLSXExports the currently active root level’s content to a file in Office Open XML spreadsheet format (XLSX).ExportGridToXLSXStreamExports content of a data grid control to a stream in Office Open XML spreadsheet format (XLSX).ExportGridToXMLExports content of a data grid control to a file in XML format.ExportGridToXMLStreamExports content of a data grid control to a stream in XML format.

VCL Scheduler Export Methods

cxExportSchedulerToCSVExports user events from a scheduler control to a file in CSV (comma-separated values) format.cxExportSchedulerToExcelExports user events from a scheduler control to a file in Microsoft Excel® binary format (XLS).cxExportSchedulerToHTMLExports user events from a scheduler control to a file in HTML format.cxExportSchedulerToTextExports user events from a scheduler control to a file in plain text format.cxExportSchedulerToXLSXExports user events from a scheduler control to a file in Office Open XML spreadsheet format (XLSX).cxExportSchedulerToXMLExports user events from a scheduler control to a file in XML format.

VCL Pivot Grid Export Methods

cxExportPivotGridDataToExcelExports unformatted data from a pivot grid to a file in XLS or XLSX format.cxExportPivotGridToCSVExports content of a pivot grid to a file in CSV (comma-separated values) format.cxExportPivotGridToExcelExports content of a pivot grid to a file in Microsoft Excel® binary format (XLS).cxExportPivotGridToFileExports content of a pivot grid to a file in a specified format.cxExportPivotGridToHTMLExports content of a pivot grid to a file in HTML format.cxExportPivotGridToTextExports content of a pivot grid to a file in plain text format.cxExportPivotGridToXLSXExports content of a pivot grid to a file in Office Open XML spreadsheet format (XLSX).cxExportPivotGridToXMLExports content of a pivot grid to a file in XML format.

VCL Tree List Export Methods

cxExportTLToCSVExports content of a tree list control to a file in CSV (comma-separated values) format.cxExportTLToExcelExports content of a tree list control to a file in Microsoft Excel® binary format (XLS).cxExportTLToHTMLExports content of a tree list control to a file in HTML format.cxExportTLToTextExports content of a tree list control to a file in plain text format.cxExportTLToXLSXExports content of a tree list control to a file in Office Open XML spreadsheet format (XLSX).cxExportTLToXMLExports content of a tree list control to a file in XML format.

VCL Vertical Grid Export Methods

cxExportVGToCSVExports content of a vertical grid control to a file in CSV (comma-separated values) format.cxExportVGToExcelExports content of a vertical grid control to a file in Microsoft Excel® binary format (XLS).cxExportVGToHTMLExports content of a vertical grid control to a file in HTML format.cxExportVGToTextExports content of a vertical grid control to a file in plain text format.cxExportVGToXLSXExports content of a vertical grid control to a file in Office Open XML format.cxExportVGToXMLExports content of a vertical grid control to a file in XML format.

Refer to the following topic for details: How to: Track Data Export Progress.

Inheritance

IInterface IcxProgress IcxExportProgress

See Also

IcxExportBeforeSave

VCL Data Grid: Data Export

VCL Vertical Grid: Data Export

VCL Pivot Grid: Data Export

VCL Tree List: Data Export

IcxExportProgress Members

cxExport Unit