Class ClientReportSource

Represents a client-side report source configuration used for communication between client applications and the Telerik Reporting Services Web API.

Inheritance
System.Object
ClientReportSource
Namespace: Telerik.Reporting.Services.WebApi
Assembly: Telerik.Reporting.Services.WebApi.dll

Syntax

public class ClientReportSource
Remarks

This class encapsulates the report reference and parameter values required to generate reports on the server side. It serves as a data transfer object that clients use to specify which report to process and what parameter values to apply.

Constructors

ClientReportSource()

Declaration
public ClientReportSource()

Properties

ParameterValues

Gets or sets the collection of report parameter name-value pairs to be passed to the reporting engine during report processing.

Declaration
public Dictionary<string, object> ParameterValues { get; set; }
Property Value
System.Collections.Generic.Dictionary<System.String, System.Object>

A dictionary where keys represent parameter names and values represent the corresponding parameter values. Can be null if the report has no parameters.
Remarks

Parameter values are used to populate report parameters during report processing. The parameter names must match exactly the parameter names defined in the report definition. Parameter values will be automatically converted to the appropriate data types expected by the report parameters.

Report

Gets or sets the string representation of the report document reference that identifies which report to process.

Declaration
public string Report { get; set; }
Property Value
System.String

A string that represents either a TypeReportSource or UriReportSource reference used to locate the report.
Remarks

The string representation must be of a TypeReportSource or UriReportSource. Other report source types are not supported by the Web API service. For TypeReportSource, this should be the assembly-qualified type name of the report class. For UriReportSource, this should be the URI path to the report definition file.

See Also