Back to Devexpress

DataViewBase.ExportToPdf(Stream, PdfExportOptions) Method

wpf-devexpress-dot-xpf-dot-grid-dot-dataviewbase-dot-exporttopdf-x28-system-dot-io-dot-stream-devexpress-dot-xtraprinting-dot-pdfexportoptions-x29.md

latest4.4 KB
Original Source

DataViewBase.ExportToPdf(Stream, PdfExportOptions) Method

Exports the control to a stream in PDF format and applies PDF export options.

Namespace : DevExpress.Xpf.Grid

Assembly : DevExpress.Xpf.Grid.v25.2.Core.dll

NuGet Package : DevExpress.Wpf.Grid.Core

Declaration

csharp
public void ExportToPdf(
    Stream stream,
    PdfExportOptions options
)
vb
Public Sub ExportToPdf(
    stream As Stream,
    options As PdfExportOptions
)

Parameters

NameTypeDescription
streamStream

The stream for the exported data.

| | options | PdfExportOptions |

The PDF export options.

|

Remarks

To display a Print Preview of the control, use the DataViewBase.ShowPrintPreview and DataViewBase.ShowPrintPreviewDialog methods. To print the control, use the DataViewBase.Print and DataViewBase.PrintDirect methods.

Note

You can preview, print, and export the control’s data only if the DXPrinting Library is available.

Refer to the following topics for more information on how to print data:

Example

This example shows how to preview, print, and export the GridControl‘s content.

View Example

xaml
<Grid>
    <Grid.RowDefinitions>
        <RowDefinition Height="*"/>
        <RowDefinition Height="Auto"/>
    </Grid.RowDefinitions>
    <dxg:GridControl x:Name="grid" AutoGenerateColumns="AddNew">
        <dxg:GridControl.View>
            <dxg:TableView x:Name="view" AutoWidth="True"/>
        </dxg:GridControl.View>
    </dxg:GridControl>
    <WrapPanel Grid.Row="1" Orientation="Horizontal">
        <Button Click="PreviewGrid" Content="Show Print Preview"/>
        <Button Click="ExportToXls" Content="Export to Excel"/>
        <Button Click="ExportToCsv" Content="Export to CSV"/>
        <Button Click="ExportToPng" Content="Export to an image"/>
    </WrapPanel>
</Grid>
cs
void PreviewGrid(object sender, RoutedEventArgs e) {
    view.ShowPrintPreviewDialog(this);
}
void ExportToXls(object sender, RoutedEventArgs e) {
    view.ExportToXlsx(@"d:\grid_export.xlsx");
}
void ExportToCsv(object sender, RoutedEventArgs e) {
    view.ExportToCsv(@"d:\grid_export.csv");
}
void ExportToPng(object sender, RoutedEventArgs e) {
    view.ExportToImage(@"d:\grid_export.png");
}
vb
Private Sub PreviewGrid(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Me.view.ShowPrintPreviewDialog(Me)
End Sub

Private Sub ExportToXls(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Me.view.ExportToXlsx("d:\grid_export.xlsx")
End Sub

Private Sub ExportToCsv(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Me.view.ExportToCsv("d:\grid_export.csv")
End Sub

Private Sub ExportToPng(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Me.view.ExportToImage("d:\grid_export.png")
End Sub

See Also

DataViewBase Class

DataViewBase Members

DevExpress.Xpf.Grid Namespace