DocumentViewer.DocumentSource Property

Specifies a document supplier for the DocumentViewer.

Namespace: DevExpress.XtraPrinting.Preview

Assembly: DevExpress.XtraPrinting.v18.2.dll

Declaration

C#

[DefaultValue(null)]
public object DocumentSource { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property DocumentSource As Object

Property Value

Type	Default	Description
Object	*null*	A Object value.

Remarks

Use the DocumentSource property to assign an object that will supply a document for the DocumentViewer. This object must implement the IDocumentSource interface (typically, this is an XtraReport, PrintingSystem or RemoteDocumentSource object).

You can specify this property at design time using the control’s smart tag.

When assigning the DocumentSource at runtime, additionally, call the CreateDocument method of a supplier object to generate a document ready to preview.

For more information, refer to the following tutorials.

• How to: Preview, Export and Print an XtraReport
• How to: Preview, Export and Print a Windows Forms Control
• How to: Preview, Export and Print a Remotely Created Document

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.

C#

Reporting_how-to-create-a-drill-through-report-that-supports-backward-navigation-to-a-t455654/CS/ExtendedDrillThroughReport/Form1.cs#L18

    report.CreateDocument();
    documentViewer1.DocumentSource = report;
}

Reporting_getting-started-xtrareports-e5144/CS/SalaryReports - Step 11/UserControls/DocumentViewerUserControl.cs#L32

report = value;
documentViewer1.DocumentSource = report;
if (report != null)

Reporting_how-to-create-a-new-report-as-a-continuation-of-the-previous-report-t234649/CS/MainForm.cs#L16

    rep.CreateDocument();
    documentViewer1.DocumentSource = rep;
}

Reporting_how-to-conditionally-suppress-summary-footer-cell-painting-by-using-formatting-t211184/CS/dxSample/Form1.cs#L13

    report.CreateDocument();
    documentViewer1.DocumentSource = report;
}

Reporting_sqldatasource-how-to-use-expressionevaluator-to-programmatically-filter-report-t328522/CS/Form1.cs#L23

XtraReport report = new XtraReport2();
documentViewer1.DocumentSource = report;
report.CreateDocument();

VB.NET

Reporting_how-to-create-a-drill-through-report-that-supports-backward-navigation-to-a-t455654/VB/ExtendedDrillThroughReport/Form1.vb#L20

    report.CreateDocument()
    documentViewer1.DocumentSource = report
End Sub

Reporting_getting-started-xtrareports-e5144/VB/SalaryReports - Step 10/UserControls/DocumentViewerUserControl.vb#L28

report_Renamed = value
documentViewer1.DocumentSource = report_Renamed
If report_Renamed IsNot Nothing Then

Reporting_how-to-create-a-new-report-as-a-continuation-of-the-previous-report-t234649/VB/MainForm.vb#L18

    rep.CreateDocument()
    documentViewer1.DocumentSource = rep
End Sub

Reporting_how-to-conditionally-suppress-summary-footer-cell-painting-by-using-formatting-t211184/VB/dxSample/Form1.vb#L15

    report.CreateDocument()
    documentViewer1.DocumentSource = report
End Sub

Reporting_sqldatasource-how-to-use-expressionevaluator-to-programmatically-filter-report-t328522/VB/Form1.vb#L25

Dim report As XtraReport = New XtraReport2()
documentViewer1.DocumentSource = report
report.CreateDocument()