WYSIWYG Export
- 6 minutes to read
In this mode, an exported document retains the layout of grid cells. Grid data shaping features in the exported document are not supported in contrast to the data-aware export. This mode uses the Printing-Exporting library to export data.
#Export Data in Code
The GridControl allows you to export its data to a file or stream. The following code sample exports GridControl data to a PDF file:
void Button_Click_Export(object sender, RoutedEventArgs e) {
view.ExportToPdf(@"c:\Example\grid_export.pdf");
}
Method | Description |
---|---|
Data |
Exports a grid to the specified file path as HTML. |
Data |
Exports a grid to the specified file path as image. |
Data |
Exports a grid to the specified file path as MHT. |
Data |
Exports a grid to the specified file path as PDF. |
Data |
Exports a grid to the specified file path as RTF. |
Data |
Exports a grid to the specified file path as text. |
Data |
Exports a grid to the specified file path as XPS. |
Table |
Exports a grid to the specified file path as CSV. |
Table |
Exports a grid to the specified file path as XLS. |
Table |
Exports a grid to the specified file path as XLSX. |
* These methods use data-aware export mode. To enable WYSIWYG mode in these methods, do one of the following:
Set the ExportSettings.DefaultExportType property to ExportType.WYSIWYG to enable WYSIWYG export mode for all export methods.
using DevExpress.Export; public partial class App : Application { static App() { ExportSettings.DefaultExportType = ExportType.WYSIWYG; } }
Call a method with the XlsExportOptionsEx.ExportType, XlsxExportOptionsEx.ExportType, or CsvExportOptionsEx.ExportType property set to WYSIWYG.
#Export Data with Print Preview
The Print Preview window allows end users to print a document and export it to a file in the required format.
Method | Description |
---|---|
Data |
Creates the print document from the View and displays the document’s Print Preview. |
Data |
Creates the print document from the View and displays the document’s modal Print Preview. |
Data |
Creates the print document from the View and displays the document’s Print Preview with the Ribbon. |
Data |
Creates the print document from the View and displays the document’s modal Print Preview with the Ribbon. |
#Customize Appearance
WYSIWYG export mode uses the same customization options that change printed GridControl appearance.
Note
Exported Grid
GridControl Views have styles and templates that define exported GridControl appearance.
#Example: Change Column Header Appearance
<Window
xmlns:dxgt="http://schemas.devexpress.com/winfx/2008/xaml/grid/themekeys">
<Window.Resources>
<Style x:Key="customPrintColumnHeaderStyle"
TargetType="dxe:BaseEdit"
BasedOn="{StaticResource {dxgt:TableViewThemeKey ResourceKey=DefaultPrintHeaderStyle}}">
<Setter Property="Background" Value="White" />
<Setter Property="FontWeight" Value="Bold" />
</Style>
</Window.Resources>
<dxg:GridControl.View>
<dxg:TableView PrintColumnHeaderStyle="{StaticResource customPrintColumnHeaderStyle}"/>
</dxg:GridControl.View>
#Example: Bind Cell Background to a Property Value
The following code sample uses brushes specified in the Color column to paint the background of Product Name cells when you export data:
<!--
xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid"
xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors"
xmlns:dxgt="http://schemas.devexpress.com/winfx/2008/xaml/grid/themekeys"
-->
<dxg:GridColumn FieldName="ProductName">
<dxg:GridColumn.PrintCellStyle>
<Style TargetType="dxe:TextEdit"
BasedOn="{StaticResource {dxgt:TableViewThemeKey ResourceKey=DefaultPrintCellStyle}}">
<Setter Property="Background" Value="{Binding RowData.Row.Color}"/>
</Style>
</dxg:GridColumn.PrintCellStyle>
</dxg:GridColumn>
#Example: Render Images within Data Cells with PopupImageEdit
<Window ...
xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors"
xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid"
xmlns:dxgt="http://schemas.devexpress.com/winfx/2008/xaml/grid/themekeys"
xmlns:dxp="http://schemas.devexpress.com/winfx/2008/xaml/printing">
<!-- ... -->
<Style x:Key="ImageColumnPrintingStyle"
TargetType="{x:Type dxe:PopupImageEdit}"
BasedOn="{StaticResource {dxgt:TableViewThemeKey ResourceKey=DefaultPrintCellStyle}}">
<Setter Property="dxp:ExportSettings.TargetType" Value="Panel"/>
<Setter Property="DisplayTemplate">
<Setter.Value>
<ControlTemplate TargetType="dxe:PopupImageEdit">
<dxe:ImageEdit Source="{Binding Path=Value}"
IsPrintingMode="True"/>
</ControlTemplate>
</Setter.Value>
</Setter>
</Style>
<!-- ... -->
<dxg:GridColumn FieldName="Image"
PrintCellStyle="{StaticResource ImageColumnPrintingStyle}">
<dxg:GridColumn.EditSettings>
<dxe:PopupImageEditSettings/>
</dxg:GridColumn.EditSettings>
</dxg:GridColumn>
To additionally customize your document, use Printing Links. For example:
To fully display visible columns on a page, use PrintableControlLink and specify the LinkBase.VerticalContentSplitting property:
To export multiple controls to the same document, use CompositeLink.
Property | Description |
---|---|
Templated |
Allows you to customize a page header in the output document. |
Templated |
Allows you to customize a report header in the output document. |
Templated |
Allows you to customize a page footer in the output document. |
Templated |
Allows you to customize a report footer in the output document. |
#WYSIWYG export Options
#Table View Options
Property | Description |
---|---|
Data |
Specifies whether the Summary Panel is printed. |
Data |
Specifies whether the Fixed Summary Panel is printed. |
Grid |
Specifies whether the grid is printed with all group rows expanded. |
Table |
Specifies whether printed column widths are automatically changed to allow the grid to fit the width of the report page. |
Table |
Specifies whether column headers are printed. |
Table |
Specifies whether group footers are printed. |
Base |
Allows you to hide specific columns when printing or exporting a grid. |
#Card View Options
Property | Description |
---|---|
Data |
Specifies whether the Summary Panel is printed. |
Data |
Specifies whether the Fixed Summary Panel is printed. |
Grid |
Specifies whether the grid is printed with all group rows expanded. |
Card |
Specifies whether cards in the print/export output are automatically resized horizontally to fit the report page width. |
Card |
Specifies the thickness of a frame around a card. |
Card |
Specifies the maximum number of card columns for printing/exporting. |
Base |
Allows you to hide specific columns when printing or exporting a grid. |
#TreeList View Options
Property | Description |
---|---|
Data |
Specifies whether the Summary Panel is printed. |
Data |
Specifies whether the Fixed Summary Panel is printed. |
Tree |
Specifies whether the grid is printed with all nodes expanded. |
Tree |
Specifies whether printed column width is automatically changed to allow the grid to fit the width of the report page. |
Tree |
Specifies whether column headers are printed. |
Base |
Allows you to hide columns when printing or exporting a grid. |
#Master-Detail Options
Property | Description |
---|---|
Table |
Specifies whether View details are printed. |
Table |
Specifies whether View details that don’t contain any data are printed. |
Table |
Specifies the top print detail indent separating the details. |
Table |
Specifies the bottom print detail indent separating the details. |