DataGridToPdfConverter class

A helper class to export the SfDataGrid to Pdf.

Override this class and required methods from this class to perform the customized exporting operation.




autoColumnWidth bool
Decides whether the all columns width should be set auto width(actual width).
getter/setter pair
canRepeatHeaders bool
Decides whether the headers should be repeated to all pages in the pdf document.
getter/setter pair
cellExport DataGridCellPdfExportCallback?
Details for the callback that use DataGridCellPdfExportDetails
getter/setter pair
columns List<GridColumn>
The collection of grid columns that proceeds to export.
no setter
excludeColumns List<String>
Excludes certain columns to the exporting.
getter/setter pair
exportStackedHeaders bool
Decides whether the Stacked headers should be exported in the pdf document.
getter/setter pair
exportTableSummaries bool
Decides whether the table summary rows should be exported to Excel.
getter/setter pair
fitAllColumnsInOnePage bool
Decides whether the all columns should be fit into one page.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
headerFooterExport DataGridPdfHeaderFooterExportCallback?
Details for the callback that use DataGridPdfHeaderFooterExportDetails
getter/setter pair
rowIndex int
A row index of SfDataGrid which keeps track of the row index while exporting.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited


exportColumnHeader(SfDataGrid dataGrid, GridColumn column, String columnName, PdfGrid pdfGrid) → void
Exports a column header to Pdf
exportColumnHeaders(SfDataGrid dataGrid, List<GridColumn> columns, PdfGrid pdfGrid) → void
Exports the column headers to Pdf.
exportRow(List<GridColumn> columns, DataGridRow row, PdfGrid pdfGrid) → void
Exports a DataGridRow to Pdf.
exportRows(List<GridColumn> columns, List<DataGridRow> rows, PdfGrid pdfGrid) → void
Exports all the data rows to Pdf.
exportStackedHeaderRow(SfDataGrid dataGrid, StackedHeaderRow stackedHeaderRow, PdfGrid pdfGrid) → void
Exports a stacked header row to Pdf.
exportStackedHeaderRows(SfDataGrid dataGrid, PdfGrid pdfGrid) → void
Exports all the stacked header rows to Pdf.
exportTableSummaryRow(SfDataGrid dataGrid, GridTableSummaryRow summaryRow, PdfGrid pdfGrid) → void
Export table summary row to the Excel.
exportTableSummaryRows(SfDataGrid dataGrid, GridTableSummaryRowPosition position, PdfGrid pdfGrid) → void
Export table summary rows to the Excel.
exportToPdfDocument(SfDataGrid dataGrid, List<DataGridRow>? rows) → PdfDocument
Exports the SfDataGrid to PdfDocument.
exportToPdfGrid(SfDataGrid dataGrid, List<DataGridRow>? rows) → PdfGrid
Exports the SfDataGrid to PdfGrid.
getCellValue(GridColumn column, DataGridRow row) Object?
Gets the cell value required for data rows.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
toString() String
A string representation of this object.


operator ==(Object other) bool
The equality operator.