DocumentViewerControl.DocumentSource Property

Specifies the document source. This is a dependency property.

Namespace: DevExpress.Xpf.DocumentViewer

Assembly: DevExpress.Xpf.DocumentViewer.v25.1.Core.dll

NuGet Package: DevExpress.Wpf.DocumentViewer.Core

Declaration

C#

public object DocumentSource { get; set; }

VB.NET

Public Property DocumentSource As Object

Property Value

Type	Description
Object	A Object value that specifies the document source.

Remarks

The following source types are supported:

• XtraReport
• CachedReportSource
• String (a path to a PRNX file; a path can be absolute or relative to the application’s executable file)
• Stream (PRNX content)
• Uri (a link)
• objects implementing the Windows.Storage.Streams.IRandomAccessStream interface

You can use the DocumentSource property to load a previously saved document from the PRNX file:

documentPreview.DocumentSource = @"...\Invoice.prnx";

To create a custom DocumentPreviewWindow, assign a document source to the DocumentSource property (available when using the DocumentPreviewWindow.PreviewControl property).

C#

using DevExpress.Xpf.Printing;
using System.Windows;
// ...

private void Button_Click(object sender, RoutedEventArgs e) {
    XtraReport1 report = new XtraReport1();
    var window = new DocumentPreviewWindow();
    window.PreviewControl.DocumentSource = report;
    report.CreateDocument();
    window.Show();
}

VB.NET

Imports DevExpress.Xpf.Printing
Imports System.Windows
' ...

Private Sub Button_Click(sender As Object, e As RoutedEventArgs)
    Dim report As New XtraReport1()
    Dim window = New DocumentPreviewWindow()
    window.PreviewControl.DocumentSource = report
    report.CreateDocument()
    window.Show()
End Sub

Make sure to call the XtraReport.CreateDocument method before displaying the Print Preview.

To resolve subreport names, call ReportStorageExtension.RegisterExtensionGlobal.

Related GitHub Examples

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

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-wpf-mvvm-show-report-document-preview/CS/MainWindow.xaml#L17

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

wpf-reporting-use-custom-controls-for-editing-report-content-in-print-preview/CS/MainWindow.xaml#L26

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

reporting-wpf-mvvm-how-to-validate-editing-fields/CS/MainWindow.xaml#L13

<dxp:DocumentPreviewControl RequestDocumentCreation="True"
                            DocumentSource="{Binding Report}"
                            HighlightEditingFields="True">

reporting-wpf-mvvm-viewmodel-data-to-report/CS/MainWindow.xaml#L19

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

C#

reporting-wpf-create-drill-down-report-document-preview-control/CS/dxWPFApp/MainWindow.xaml.cs#L43

masterReport = GetMasterReport();
preview.DocumentSource = masterReport;
masterReport.CreateDocument();

wpf-data-grid-add-page-headers-and-footers-to-exported-data/CS/GridPrint/Window1.xaml.cs#L47

DocumentPreviewWindow wnd = new DocumentPreviewWindow();
wnd.PreviewControl.DocumentSource = link;
link.CreateDocument();

reporting-wpf-print-listview-data/CS/Window1.xaml.cs#L18

DocumentPreviewWindow preview = new DocumentPreviewWindow();
preview.PreviewControl.DocumentSource = link;

VB.NET

reporting-wpf-create-drill-down-report-document-preview-control/VB/dxWPFApp/MainWindow.xaml.vb#L44

masterReport = GetMasterReport()
preview.DocumentSource = masterReport
masterReport.CreateDocument()

wpf-data-grid-add-page-headers-and-footers-to-exported-data/VB/GridPrint/Window1.xaml.vb#L36

Dim wnd As DocumentPreviewWindow = New DocumentPreviewWindow()
wnd.PreviewControl.DocumentSource = link
link.CreateDocument()

reporting-wpf-print-listview-data/VB/Window1.xaml.vb#L21

Dim preview As DocumentPreviewWindow = New DocumentPreviewWindow()
preview.PreviewControl.DocumentSource = link
link.PageHeaderTemplate = CType(Resources("printHeaderTemplate"), DataTemplate)