Invoke the Report Preview from Code

• Jun 11, 2019
• 2 minutes to read

This topic describes how you can display the preview of a specific IReportDataV2 object from a custom Controller code.

The ReportServiceController provides the ReportServiceController.ShowPreview method you can call to invoke the report preview window. The code below demonstrates how to use this method.

C#

using DevExpress.ExpressApp.ReportsV2;
using DevExpress.Persistent.Base;

// Uncomment this line in XPO-based application:
// using DevExpress.Persistent.BaseImpl;

// Uncomment this line in EF-based application:
// using DevExpress.Persistent.BaseImpl.EF;

// ...
IObjectSpace objectSpace = 
    ReportDataProvider.ReportObjectSpaceProvider.CreateObjectSpace(typeof(ReportDataV2));
IReportDataV2 reportData = 
    objectSpace.FindObject<ReportDataV2>(
    CriteriaOperator.Parse("[DisplayName] = 'Contacts Report'"));
string handle = ReportDataProvider.ReportsStorage.GetReportContainerHandle(reportData);
ReportServiceController controller = Frame.GetController<ReportServiceController>();
if (controller != null) {
    controller.ShowPreview(handle);
}

VB.NET

Imports DevExpress.ExpressApp.ReportsV2
Imports DevExpress.Persistent.Base

' Uncomment this line in XPO-based application:
' Imports DevExpress.Persistent.BaseImpl

' Uncomment this line in EF-based application:
' Imports DevExpress.Persistent.BaseImpl.EF

' ... 
Private objectSpace As IObjectSpace = _
ReportDataProvider.ReportObjectSpaceProvider.CreateObjectSpace(GetType(ReportDataV2))
Private reportData As IReportDataV2 = _
objectSpace.FindObject(Of ReportDataV2)(CriteriaOperator.Parse("[DisplayName] = 'Contacts Report'"))
Private handle As String = ReportDataProvider.ReportsStorage.GetReportContainerHandle(reportData)
Dim controller As ReportServiceController = Frame.GetController(Of ReportServiceController)()
If controller IsNot Nothing Then
    controller.ShowPreview(handle)
End If

In the criteria string used in the code above, substitute “Contacts Report” with the actual IReportDataV2.DisplayName value of the report you want to display.

Tip

Optionally, you can filter and sort data displayed in report using the criteria and sortProperty parameters of the ShowPreview method.