Class DataGridPdfExportingController

Represents a class which defines various options to export the SfDataGrid to a Pdf. Provides classes, methods, properties, and events to export and customize the exported values of a SfDataGrid.

Inheritance

System.Object

DataGridPdfExportingController

Namespace: Syncfusion.Maui.DataGrid.Exporting

Assembly: Syncfusion.Maui.DataGridExport.dll

Syntax

public class DataGridPdfExportingController : Object

Constructors

DataGridPdfExportingController()

Initializes a new instance of the DataGridPdfExportingController class.

Declaration

public DataGridPdfExportingController()

Properties

PdfGrid

Gets or private sets the exporing PdfGrid

Declaration

protected PdfGrid PdfGrid { get; }

Property Value

Type
PdfGrid

Methods

ExportCellValue(SfDataGrid, RecordEntry, DataGridColumn, PdfGridCell, DataGridPdfExportingOption, Object)

Exports cellvalue to the pdf document, cellvalue are obtained from the record using gridcolumn mappping name. when exporting each cell cellexporting event handler is called. For image column, image is converted as stream and then image will export. For switch column, check box will export. When overridden in a derived class, is invoked whenever application code or internal processes call ExportCellValue

Declaration

protected void ExportCellValue(SfDataGrid dataGrid, RecordEntry record, DataGridColumn column, PdfGridCell pdfCell, DataGridPdfExportingOption exportOption, object pagedRecord = null)

Parameters

Type	Name	Description
SfDataGrid	dataGrid
RecordEntry	record
DataGridColumn	column
PdfGridCell	pdfCell
DataGridPdfExportingOption	exportOption
System.Object	pagedRecord

ExportDataGridRecordToPdf(SfDataGrid, RecordEntry, PdfGridRow, DataGridPdfExportingOption, Group, Object)

Exports record to pdf. RowExporting Event handler handled here When overridden in a derived class, is invoked whenever application code or internal processes call ExportRecordToPdf

Declaration

protected void ExportDataGridRecordToPdf(SfDataGrid dataGrid, RecordEntry record, PdfGridRow pdfRow, DataGridPdfExportingOption exportOption, Group group, object pagedRecord = null)

Parameters

Type	Name	Description
SfDataGrid	dataGrid
RecordEntry	record
PdfGridRow	pdfRow
DataGridPdfExportingOption	exportOption
Group	group
System.Object	pagedRecord

ExportDetailsViewDataGridToPdf(SfDataGrid, PdfGrid, ICollectionViewAdv, DataGridPdfExportingOption, Group)

Exports the details view data grid to PDF.

Declaration

protected virtual void ExportDetailsViewDataGridToPdf(SfDataGrid detailsDataGrid, PdfGrid pdfGrid, ICollectionViewAdv view, DataGridPdfExportingOption exportOption, Group group)

Parameters

Type	Name	Description
SfDataGrid	detailsDataGrid	The details view data grid.
PdfGrid	pdfGrid	The parent PDF grid.
ICollectionViewAdv	view	The collection view.
DataGridPdfExportingOption	exportOption	The export options.
Group	group	The group.

ExportDetailsViewToPdf(SfDataGrid, PdfGrid, DataGridPdfExportingOption, RecordEntry, IPropertyAccessProvider, Group)

Exports the details view to PDF document.

Declaration

protected virtual void ExportDetailsViewToPdf(SfDataGrid parentDataGrid, PdfGrid pdfGrid, DataGridPdfExportingOption exportOption, RecordEntry record, IPropertyAccessProvider propertyAccessProvider, Group group)

Parameters

Type	Name	Description
SfDataGrid	parentDataGrid	Parent SfDataGrid instance.
PdfGrid	pdfGrid	The PDF grid to which the data should be exported.
DataGridPdfExportingOption	exportOption	PDF export options.
RecordEntry	record	The record entry.
IPropertyAccessProvider	propertyAccessProvider	IPropertyAccessProvider
Group	group	The group.

ExportSummaryCellToPdf(SfDataGrid, PdfGridCell, ExportCellType, String, String)

Export the summary cell to PDF.

Declaration

protected void ExportSummaryCellToPdf(SfDataGrid dataGrid, PdfGridCell pdfGridCell, ExportCellType exportCellType, string summaryDisplayText, string columnName)

Parameters

Type	Name	Description
SfDataGrid	dataGrid
PdfGridCell	pdfGridCell
ExportCellType	exportCellType
System.String	summaryDisplayText
System.String	columnName

ExportTableSummariesToPdf(SfDataGrid, PdfGrid, ICollectionViewAdv, DataGridPdfExportingOption)

Export the table summary rows to PDF.

Declaration

protected void ExportTableSummariesToPdf(SfDataGrid dataGrid, PdfGrid pdfGrid, ICollectionViewAdv view, DataGridPdfExportingOption exportOption)

Parameters

Type	Name	Description
SfDataGrid	dataGrid	Specifies the SfDataGrid.
PdfGrid	pdfGrid	Specifies the PdfGrid
ICollectionViewAdv	view	Specifies the SfDataGridView.
DataGridPdfExportingOption	exportOption	Specifies the instance of class which is used to set the exporting options.

ExportTableSummaryRowToPdf(SfDataGrid, PdfGrid, ICollectionViewAdv, DataGridPdfExportingOption, ExportCellType, PdfGridCellStyle, SummaryRecordEntry)

Export the table summary row to PDF.

Declaration

protected void ExportTableSummaryRowToPdf(SfDataGrid dataGrid, PdfGrid pdfGrid, ICollectionViewAdv view, DataGridPdfExportingOption exportOption, ExportCellType cellType, PdfGridCellStyle cellStyle, SummaryRecordEntry summaryRecordEntry)

Parameters

Type	Name	Description
SfDataGrid	dataGrid
PdfGrid	pdfGrid
ICollectionViewAdv	view
DataGridPdfExportingOption	exportOption
ExportCellType	cellType
PdfGridCellStyle	cellStyle
SummaryRecordEntry	summaryRecordEntry

ExportToPdf(SfDataGrid)

Exports the data in the grid to pdf document based on the default export option and returns PdfDocument.

Declaration

public PdfDocument ExportToPdf(SfDataGrid dataGrid)

Parameters

Type	Name	Description
SfDataGrid	dataGrid

Returns

Type
PdfDocument

ExportToPdf(SfDataGrid, ICollectionViewAdv, DataGridPdfExportingOption)

Exports grid to the pdf document based on the given export option and returns PdfDocument.

Declaration

public PdfDocument ExportToPdf(SfDataGrid dataGrid, ICollectionViewAdv collectionView, DataGridPdfExportingOption exportOption)

Parameters

Type	Name	Description
SfDataGrid	dataGrid
ICollectionViewAdv	collectionView
DataGridPdfExportingOption	exportOption

Returns

Type
PdfDocument

ExportToPdf(SfDataGrid, DataGridPdfExportingOption)

Exports the data in the grid to pdf document based on given export option and returns PdfDocument.

Declaration

public PdfDocument ExportToPdf(SfDataGrid dataGrid, DataGridPdfExportingOption exportOption)

Parameters

Type	Name	Description
SfDataGrid	dataGrid
DataGridPdfExportingOption	exportOption

Returns

Type
PdfDocument

ExportToPdf(SfDataGrid, ObservableCollection<Object>, DataGridPdfExportingOption)

Exports the selected row in the grid to pdf document based on either given export option or default export option and returns PdfDocument.

Declaration

public PdfDocument ExportToPdf(SfDataGrid dataGrid, ObservableCollection<object> selectedItems, DataGridPdfExportingOption pdfExportOption = null)

Parameters

Type	Name	Description
SfDataGrid	dataGrid
System.Collections.ObjectModel.ObservableCollection<System.Object>	selectedItems
DataGridPdfExportingOption	pdfExportOption

Returns

Type
PdfDocument

ExportToPdfGrid(SfDataGrid, ICollectionViewAdv, DataGridPdfExportingOption, PdfDocument)

Creates PdfGrid equivalent to the SfDataGrid.

Declaration

public PdfGrid ExportToPdfGrid(SfDataGrid dataGrid, ICollectionViewAdv collectionView, DataGridPdfExportingOption exportOption, PdfDocument pdfDocument)

Parameters

Type	Name	Description
SfDataGrid	dataGrid
ICollectionViewAdv	collectionView
DataGridPdfExportingOption	exportOption
PdfDocument	pdfDocument

Returns

Type
PdfGrid

ExportUnboundRowCellToPdf(SfDataGrid, PdfGridCell, DataGridPdfExportingOption, DataGridUnboundRow, DataGridColumn)

Export Unbound row cell value to excel.

Declaration

protected void ExportUnboundRowCellToPdf(SfDataGrid grid, PdfGridCell pdfGridCell, DataGridPdfExportingOption excelExportingOptions, DataGridUnboundRow gridUnboundRow, DataGridColumn gridColumn)

Parameters

Type	Name	Description
SfDataGrid	grid
PdfGridCell	pdfGridCell
DataGridPdfExportingOption	excelExportingOptions
DataGridUnboundRow	gridUnboundRow
DataGridColumn	gridColumn

ExportUnboundRowsToPdf(SfDataGrid, PdfGrid, DataGridPdfExportingOption, DataGridUnboundRowPosition, Boolean, ObservableCollection<DataGridUnboundRow>)

Export Unbound row to Pdf.

Declaration

protected void ExportUnboundRowsToPdf(SfDataGrid dataGrid, PdfGrid pdfGrid, DataGridPdfExportingOption exportOption, DataGridUnboundRowPosition position, bool belowSummary, ObservableCollection<DataGridUnboundRow> unBoundRows = null)

Parameters

Type	Name	Description
SfDataGrid	dataGrid
PdfGrid	pdfGrid
DataGridPdfExportingOption	exportOption
DataGridUnboundRowPosition	position
System.Boolean	belowSummary
System.Collections.ObjectModel.ObservableCollection<DataGridUnboundRow>	unBoundRows

ExportUnboundRowToPdf(SfDataGrid, PdfGridRow, DataGridPdfExportingOption, DataGridUnboundRow, ExportCellType, PdfGridCellStyle)

Export unbound row to excel.

Declaration

protected virtual void ExportUnboundRowToPdf(SfDataGrid dataGrid, PdfGridRow pdfRow, DataGridPdfExportingOption exportOption, DataGridUnboundRow gridUnboundRow, ExportCellType cellType, PdfGridCellStyle cellStyle)

Parameters

Type	Name	Description
SfDataGrid	dataGrid
PdfGridRow	pdfRow
DataGridPdfExportingOption	exportOption
DataGridUnboundRow	gridUnboundRow
ExportCellType	cellType
PdfGridCellStyle	cellStyle

Events

CellExporting

Occurs when the cell is being exported to pdf.

Declaration

public event EventHandler<DataGridCellPdfExportingEventArgs> CellExporting

Event Type

Type
System.EventHandler<DataGridCellPdfExportingEventArgs>

DataGridChildPdfExporting

Occurs when the MasterDetailsView DataGrid exporting through PDF.

Declaration

public event EventHandler<DataGridChildPdfExportingEventArgs> DataGridChildPdfExporting

Event Type

Type
System.EventHandler<DataGridChildPdfExportingEventArgs>

HeaderAndFooterExporting

Occurs when header and footer is being exported to the pdf.

Declaration

public event EventHandler<DataGridPdfHeaderFooterEventArgs> HeaderAndFooterExporting

Event Type

Type
System.EventHandler<DataGridPdfHeaderFooterEventArgs>

RowExporting

Occurs when the row is being exported to pdf.

Declaration

public event EventHandler<DataGridRowPdfExportingEventArgs> RowExporting

Event Type

Type
System.EventHandler<DataGridRowPdfExportingEventArgs>