exportToPdfDocument method

PdfDocument exportToPdfDocument({List<DataGridRow>? rows, bool exportStackedHeaders = true, bool canRepeatHeaders = true, bool fitAllColumnsInOnePage = false, bool autoColumnWidth = true, bool exportTableSummaries = true, List<String> excludeColumns = const <String>[], DataGridToPdfConverter? converter, DataGridCellPdfExportCallback? cellExport, DataGridPdfHeaderFooterExportCallback? headerFooterExport})

Exports the SfDataGrid to PdfDocument.

If the rows is set, the given list of DataGridRow collections is exported. Typically, you can set this property to export the selected rows from SfDataGrid.

Use cellExport argument as the callback, and it will be called for each cell. You can customize the cell in Pdf document.

Use fitAllColumnsInOnePage argument to fit all the columns in a page.

Use the converter argument to set the customized Pdf converter. To customize the default Pdf converter, override the DataGridToPdfConverter class and override the necessary methods.

Use the headerFooterExport argument to set the header and footer for each page.

The following example shows how to export the SfDataGrid to PdfDocument.

final GlobalKey<SfDataGridState> _key = GlobalKey<SfDataGridState>();

Future<void> exportDataGridToPdf() async {
  final PdfDocument document =
      _key.currentState!.exportToPdfDocument(fitAllColumnsInOnePage: true);
  final List<int> bytes = document.save();
  File('DataGrid.pdf').writeAsBytes(bytes);
  document.dispose();
}

@override
Widget build(BuildContext context) {
  return Scaffold(
    appBar: AppBar(
      title: const Text(
        'Syncfusion Flutter DataGrid Export',
        overflow: TextOverflow.ellipsis,
      ),
    ),
    body: Column(
      children: <Widget>[
        Container(
          margin: const EdgeInsets.all(12.0),
          child: const SizedBox(
            height: 40.0,
            width: 150.0,
            child: MaterialButton(
                color: Colors.blue,
                child: Center(
                    child: Text(
                  'Export to PDF',
                  style: TextStyle(color: Colors.white),
                )),
                onPressed: exportDataGridToPdf),
          ),
        ),
        Expanded(
          child: SfDataGrid(
            key: _key,
            source: employeeDataSource,
            columns: <GridColumn>[
              GridColumn(
                  columnName: 'ID',
                  label: Container(
                      padding: const EdgeInsets.all(16.0),
                      alignment: Alignment.center,
                      child: const Text(
                        'ID',
                      ))),
              GridColumn(
                  columnName: 'Name',
                  label: Container(
                      padding: const EdgeInsets.all(8.0),
                      alignment: Alignment.center,
                      child: const Text('Name'))),
              GridColumn(
                  columnName: 'Designation',
                  label: Container(
                      padding: const EdgeInsets.all(8.0),
                      alignment: Alignment.center,
                      child: const Text(
                        'Designation',
                        overflow: TextOverflow.ellipsis,
                      ))),
              GridColumn(
                  columnName: 'Salary',
                  label: Container(
                      padding: const EdgeInsets.all(8.0),
                      alignment: Alignment.center,
                      child: const Text('Salary'))),
            ],
          ),
        ),
      ],
    ),
  );
}

Implementation

PdfDocument exportToPdfDocument(
    {List<DataGridRow>? rows,
    bool exportStackedHeaders = true,
    bool canRepeatHeaders = true,
    bool fitAllColumnsInOnePage = false,
    bool autoColumnWidth = true,
    bool exportTableSummaries = true,
    List<String> excludeColumns = const <String>[],
    DataGridToPdfConverter? converter,
    DataGridCellPdfExportCallback? cellExport,
    DataGridPdfHeaderFooterExportCallback? headerFooterExport}) {
  converter ??= DataGridToPdfConverter();
  _initializeProperties(converter,
      autoColumnWidth: autoColumnWidth,
      fitAllColumnsInOnePage: fitAllColumnsInOnePage,
      canRepeatHeaders: canRepeatHeaders,
      exportStackedHeaders: exportStackedHeaders,
      cellExport: cellExport,
      headerFooterExport: headerFooterExport,
      excludeColumns: excludeColumns,
      exportTableSummaries: exportTableSummaries);

  return converter.exportToPdfDocument(widget, rows);
}