IReportServerClient Interface

If implemented by a class, provides the client-side functionality for a DevExpress Report Server.

Namespace: DevExpress.ReportServer.ServiceModel.Client

Assembly: DevExpress.Printing.v18.1.Core.dll

Declaration

C#

public interface IReportServerClient :
    IReportServiceClient,
    IServiceClientBase

VB.NET

Public Interface IReportServerClient
    Inherits IReportServiceClient,
             IServiceClientBase

Related API Members

The following members accept/return IReportServerClient objects:

• ConnectionProvider.CreateClient()
• ReportServerClientFactory.Create()

Remarks

The base class that implements this interface is ReportServerClient.

To learn more, refer to the Report and Dashboard Server documentation.

Related GitHub Examples

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

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_report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application-t431255/CS/ScheduledTasksAPIClientDemo/ConnectionProviderExtensions.cs#L8

public static class ConnectionProviderExtensions {
    public static Task<T> DoWithScheduledJobAsync<T>(this ConnectionProvider serverConnection, Func<IReportServerClient, Task<T>> func) {
        return serverConnection

Reporting_report-server-get-the-list-of-reports-and-display-a-preview-in-a-winforms-e5062/CS/ReportServerWinFormsClientDemo/MainForm.cs#L47

.ContinueWith(task => {
    IReportServerClient client = task.Result;
    client.SetSynchronizationContext(uiContext);

Reporting_report-server-how-to-get-available-reports-and-show-them-in-wpf-document-viewer-t258870/CS/T258870/ViewModel/MainViewModel.cs#L43

.ContinueWith(task => {
    IReportServerClient client = task.Result;
    client.SetSynchronizationContext(uiContext);

Reporting_report-server-how-to-export-a-report-from-code-in-a-console-application-t155725/CS/T155725/Program.cs#L22

static void ExportToPdf(string serverAddress, string fileName, int reportId, params ReportParameter[] parameters) {
    IReportServerClient client =
        new GuestConnectionProvider(serverAddress).ConnectAsync().Result;

Reporting_report-server-how-to-print-or-export-a-report-from-code-in-a-winforms-application-t317142/CS/ReportServerWinForms/MainForm.cs#L57

.ContinueWith(t => {
    IReportServerClient client = t.Result;
    return Task.Factory.ExportReportAsync(client, new ReportIdentity(reportId), exportOptions, parameters, null);

VB.NET

Reporting_report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application-t431255/VB/ScheduledTasksAPIClientDemo/ConnectionProviderExtensions.vb#L9

<System.Runtime.CompilerServices.Extension> _
Public Function DoWithScheduledJobAsync(Of T)(ByVal serverConnection As ConnectionProvider, ByVal func As Func(Of IReportServerClient, Task(Of T))) As Task(Of T)
    Return serverConnection.ConnectAsync().ContinueWith(Function(taskFunc)

Reporting_report-server-get-the-list-of-reports-and-display-a-preview-in-a-winforms-e5062/VB/ReportServerWinFormsClientDemo/MainForm.vb#L47

serverConnection.ConnectAsync().ContinueWith(Function(task)
    Dim client As IReportServerClient = task.Result
    client.SetSynchronizationContext(uiContext)

Reporting_report-server-how-to-get-available-reports-and-show-them-in-wpf-document-viewer-t258870/VB/T258870/ViewModel/MainViewModel.vb#L61

serverConnection.ConnectAsync().ContinueWith(Function(task)
    Dim client As IReportServerClient = task.Result
    client.SetSynchronizationContext(uiContext)

Reporting_report-server-how-to-export-a-report-from-code-in-a-console-application-t155725/VB/T155725/Program.vb#L22

Private Shared Sub ExportToPdf(ByVal serverAddress As String, ByVal fileName As String, ByVal reportId As Integer, ParamArray ByVal parameters() As ReportParameter)
    Dim client As IReportServerClient = (New GuestConnectionProvider(serverAddress)).ConnectAsync().Result
    'new ServerUserConnectionProvider(serverAddress, "demo", "demo").ConnectAsync().Result;

Reporting_report-server-how-to-print-or-export-a-report-from-code-in-a-winforms-application-t317142/VB/ReportServerWinForms/MainForm.vb#L54

serverConnection.ConnectAsync().ContinueWith(Function(t)
    Dim client As IReportServerClient = t.Result
    Return Task.Factory.ExportReportAsync(client, New ReportIdentity(reportId), exportOptions, parameters, Nothing)