DataGridToExcelConverter class
A helper class to export the SfDataGrid
to Excel.
Override this class and required methods from this class to perform the customized exporting operation.
Constructors
Properties
- cellExport ↔ DataGridCellExcelExportCallback?
-
Holds the cell export callback function.
getter/setter pair
-
columns
→ List<
GridColumn> -
The collection of grid columns that proceeds to export.
no setter
- defaultColumnWidth ↔ double
-
The default width of the columns in Excel while exporting.
getter/setter pair
- defaultRowHeight ↔ double
-
The default height of the rows in Excel while exporting.
getter/setter pair
- excelColumnIndex ↔ int
-
A column index of
SfDataGrid
which keeps track of the column index while exporting.getter/setter pair - excelRowIndex ↔ int
-
A row index of
SfDataGrid
which keeps track of the row index while exporting.getter/setter pair -
excludeColumns
↔ List<
String> -
Excludes certain columns to the exporting.
getter/setter pair
- exportColumnWidth ↔ bool
-
Decides whether the width of the columns in
SfDataGrid
should be exported same in Excel.getter/setter pair - exportRowHeight ↔ bool
-
Decides whether the height of the rows in
SfDataGrid
should be exported same in Excel.getter/setter pair - exportStackedHeaders ↔ bool
-
Decides whether the stacked headers should be exported to Excel.
getter/setter pair
- exportTableSummaries ↔ bool
-
Decides whether the table summary rows should be exported to Excel.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- startColumnIndex ↔ int
-
The start of the column index in Excel. The first column of the SfDataGrid
will begin at this column index in Excel
getter/setter pair
- startRowIndex ↔ int
-
The start of the row index in Excel. The first row of the SfDataGrid will
begin at this row index in Excel.
getter/setter pair
Methods
-
exportColumnHeader(
SfDataGrid dataGrid, GridColumn column, String columnName, Worksheet worksheet) → void - Exports a column header to Excel.
-
exportColumnHeaders(
SfDataGrid dataGrid, Worksheet worksheet) → void - Exports the column headers to Excel.
-
exportRow(
SfDataGrid dataGrid, DataGridRow row, GridColumn column, Worksheet worksheet) → void -
Exports a
DataGridRow
to Excel. -
exportRows(
SfDataGrid dataGrid, List< DataGridRow> rows, Worksheet worksheet) → void - Exports all the data rows to Excel.
-
exportStackedHeaderRow(
SfDataGrid dataGrid, StackedHeaderRow stackedHeaderRow, Worksheet worksheet) → void - Exports a stacked header row to Excel.
-
exportStackedHeaderRows(
SfDataGrid dataGrid, Worksheet worksheet) → void - Exports all the stacked header rows to Excel.
-
exportTableSummaryRow(
SfDataGrid dataGrid, GridTableSummaryRow summaryRow, Worksheet worksheet) → void - Export table summary row to the Excel.
-
exportTableSummaryRows(
SfDataGrid dataGrid, GridTableSummaryRowPosition position, Worksheet worksheet) → void - Export table summary rows to the Excel.
-
exportToExcelWorkbook(
SfDataGrid dataGrid, List< DataGridRow> ? rows) → Workbook -
Exports the
SfDataGrid
to ExcelWorkbook
. -
exportToExcelWorksheet(
SfDataGrid dataGrid, List< DataGridRow> ? rows, Worksheet worksheet) → void -
Exports the
SfDataGrid
to ExcelWorksheet
. -
getCellValue(
DataGridRow row, GridColumn column) → Object? - Gets the cell value required for data rows.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited