DocumentPreviewControl Class

A control that you can use to publish (preview, print, and export) documents in WPF applications.

Namespace: DevExpress.Xpf.Printing

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

NuGet Package: DevExpress.Wpf.Printing

Declaration

C#

public class DocumentPreviewControl :
    DocumentViewerControl,
    IParameterPanelHandler,
    IDocumentPreviewUI

VB.NET

Public Class DocumentPreviewControl
    Inherits DocumentViewerControl
    Implements IParameterPanelHandler,
               IDocumentPreviewUI

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.

Do the following to create a Print Preview to publish documents:

1. Assign a document source to the DocumentPreviewControl’s DocumentSource property.

   The following types of document sources are supported:

   • An object that implements the IReport interface.
   • An object that implements the ILink interface.
   • A Stream that contains report document data.
   • A string that contains a path to a file that stores report document data (a PRNX file).

2. If you use an IReport or ILink object as a document source, call the document source’s CreateDocument method or set the DocumentPreviewControl’s RequestDocumentCreation property to True 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.

XAML

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-wpf-custom-editor-for-report-parameter/CS/CustomParameterEditorsWPF/MainWindow.xaml#L36

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

Reporting_how-to-sort-a-report-in-document-preview-for-wpf-e3441/CS/PreviewSortSample/MainWindow.xaml#L17

<Grid>
    <dxp:DocumentPreviewControl RequestDocumentCreation="True" Name="preview" DocumentSource="{Binding Report}" >
        <dxmvvm:Interaction.Behaviors>

Reporting_how-to-automatically-assign-appropriate-editors-for-document-editing-in-print-t561690/CS/CustomEditingFieldsSelector/MainWindow.xaml#L36

<Grid>
    <dxp:DocumentPreviewControl RequestDocumentCreation="True" Name="preview">
        <dxp:DocumentPreviewControl.EditingFieldTemplateSelector>

Reporting_how-to-use-custom-controls-for-editing-report-content-in-print-preview-t456791/CS/WpfApplication1/MainWindow.xaml#L26

<DataTemplate>
    <dxp:DocumentPreviewControl RequestDocumentCreation="True" DocumentSource="{Binding Report, Mode=OneWay}" />
</DataTemplate>

Inheritance

Object

DispatcherObject

DependencyObject

Visual

UIElement

FrameworkElement

Control

DocumentViewerControl

DocumentPreviewControl