Interface IReportService

Represents the Telerik Reporting service.

Namespace: Telerik.Reporting.Service
Assembly: Telerik.Reporting.Service.dll

Syntax

public interface IReportService

Methods

GetPage(String, Int32)

Retrieves a rendered page for the given rendering session ID and page number. This operation is intended for internal use only.

Declaration
PageInfo GetPage(string instanceID, int pageNumber)
Parameters
System.String instanceID

The unique identifier of the rendering session as returned by a previous call to a RenderAndCache operation.
System.Int32 pageNumber

The serial number of the page to retrieve.
Returns
PageInfo

A PageInfo that contains the page data.

GetReportParameters(String, NameValueDictionary, NameValueDictionary)

Retrieve a list of the report parameters for the given report and values. This operation is intended for internal use only.

Declaration
List<Parameter> GetReportParameters(string report, NameValueDictionary deviceInfo, NameValueDictionary parameters)
Parameters
System.String report

The System.Type.AssemblyQualifiedName of the report type for which to obtain the parameters.
NameValueDictionary deviceInfo

A dictionary with settings for the current device.
NameValueDictionary parameters

A dictionary with values for the report parameters.
Returns
System.Collections.Generic.List<Parameter>

A list of report parameters.

ListAvailableReports()

Retrieves the list of the available for the service reports.

Declaration
IList<ReportInfo> ListAvailableReports()
Returns
System.Collections.Generic.IList<ReportInfo>

List of the available reports.

ListRenderingExtensions()

Retrieves the list of the available rendering extensions.

Declaration
IList<ExtensionInfo> ListRenderingExtensions()
Returns
System.Collections.Generic.IList<ExtensionInfo>

List of the available rendering extensions.

Render(String, String, NameValueDictionary, NameValueDictionary)

Renders a report and returns the generated document.

Declaration
RenderingResult Render(string format, string report, NameValueDictionary deviceInfo, NameValueDictionary parameters)
Parameters
System.String format

The render format.
System.String report

The System.Type.AssemblyQualifiedName of the report type to render.
NameValueDictionary deviceInfo

A NameValueDictionary with setting for the current render format.
NameValueDictionary parameters

A NameValueDictionary with values for the report parameters.
Returns
RenderingResult

A RenderingResult that contains the generated document bytes and info.

RenderAndCache(String, String, NameValueDictionary, NameValueDictionary)

Renders a report and stores the result in the current session. This operation is intended for internal use only.

Declaration
RenderingSessionInfo RenderAndCache(string format, string report, NameValueDictionary deviceInfo, NameValueDictionary parameters)
Parameters
System.String format

The render format.
System.String report

The System.Type.AssemblyQualifiedName of the report type to render.
NameValueDictionary deviceInfo

A NameValueDictionary with setting for the current render format.
NameValueDictionary parameters

A NameValueDictionary with values for the report parameters.
Returns
RenderingSessionInfo

A RenderingSessionInfo that contains the result of the rendering operation.
Remarks

Requires ASP.NET session.