DocumentPreviewControl Class

A control used to publish (preview, print and export) documents in WPF applications.

Namespace: DevExpress.Xpf.Printing

Assembly: DevExpress.Xpf.Printing.v18.2.dll

Declaration

C#

public class DocumentPreviewControl :
    DocumentViewerControl

VB.NET

Public Class DocumentPreviewControl
    Inherits DocumentViewerControl

Related API Members

The following members return DocumentPreviewControl objects:

• DocumentPreviewWindow.PreviewControl

Remarks

The DocumentPreviewControl allows you to choose between a Ribbon or Bars toolbar layout.

To create a Print Preview for publishing documents that are supplied by a specific source, do the following.

1. Assign an appropriate document source to the DocumentViewerControl.DocumentSource property of the current DocumentPreviewControl. The following types of document sources are supported.

   • An object implementing the IReport interface.
   • An object implementing the ILink interface.
   • A Stream containing report document data.
   • A string containing a path to a file that stores report document data (a PRNX file).
2. If you are using an IReport or ILink object as a document source, call the document source’s CreateDocument method to generate a preview.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DocumentPreviewControl class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_how-to-hide-specific-export-formats-from-the-document-preview-control-t279119/CS/HideExportFormats/MainWindow.xaml#L18

<Grid>
    <dxp:DocumentPreviewControl Name="preview" CommandBarStyle="Bars">
        <dxp:DocumentPreviewControl.HiddenExportFormats>

Reporting_how-to-provide-custom-editors-for-report-parameters-in-wpf-e3359/CS/CustomParameterEditorsWPF/MainWindow.xaml#L36

    </Window.Resources>
    <dxp:DocumentPreviewControl x:Name="preview" />
</Window>

Reporting_how-to-sort-a-report-in-documentpreviewcontrol-t329474/CS/WpfApplication1/MainWindow.xaml#L8

<dxp:DocumentPreviewControl Name="Viewer" />

Reporting_how-to-update-the-print-preview-according-to-the-changes-made-in-dxgrid-e2964/CS/PrintDXGridSample/MainWindow.xaml#L25

    <Button Content="Update Preview" Click="UpdatePreview" Grid.Row="1" />
    <dxp:DocumentPreviewControl x:Name="preview" Grid.Row="2" />
</Grid>

Reporting_documentpreview-how-to-disable-toolbar-dragging-e4417/CS/MinimalisticReportPreviewDemo/MainWindow.xaml#L12

    </dxb:BarManager.Controllers>
    <dxp:DocumentPreviewControl Name="preview" />
</dxb:BarManager>

Inheritance

Object

DispatcherObject

DependencyObject

Visual

UIElement

FrameworkElement

Control

DocumentViewerControl

DocumentPreviewControl

Extension Methods

GetErrorOperationCommands(Position)

GetErrorOperationCommands(Int32)

GetErrorOperationCommands(Point)