Back to Devexpress

IReportParametersPanelClientSideModelGenerator Interface

xtrareports-devexpress-dot-xtrareports-dot-web-dot-parameterspanel.md

latest2.4 KB
Original Source

IReportParametersPanelClientSideModelGenerator Interface

A class used to generate a client-side model for the Standalone Report Parameters Panel component.

Namespace : DevExpress.XtraReports.Web.ParametersPanel

Assembly : DevExpress.XtraReports.v25.2.Web.dll

NuGet Package : DevExpress.Web.Reporting.Common

Declaration

csharp
public interface IReportParametersPanelClientSideModelGenerator :
    IWebDocumentViewerClientSideModelGeneratorBase<ReportParametersPanelModel>
vb
Public Interface IReportParametersPanelClientSideModelGenerator
    Inherits IWebDocumentViewerClientSideModelGeneratorBase(Of ReportParametersPanelModel)

Remarks

The default implementation of IReportParametersPanelClientSideModelGenerator is registered at application startup within the AddDevExpressControls method call. In the controller action, you can get the service from the request services:

csharp
public IActionResult Panel(
    [FromQuery] string reportName,
    [FromServices] IReportParametersPanelClientSideModelGenerator clientSideModelGenerator) {
    reportName = string.IsNullOrEmpty(reportName) ? "TestReport" : reportName;
    ReportParametersPanelModel parametersPanelModel =
        clientSideModelGenerator.GetModel(reportName, WebDocumentViewerController.DefaultUri);
    return View("Panel", parametersPanelModel);
}

Note that one of the IReportParametersPanelClientSideModelGenerator.GetModel method parameters is a report name, so the application must have the report name resolution service (IReportProvider or ReportStorageWebExtension) implemented and registered at application startup.

See Also

IReportParametersPanelClientSideModelGenerator Members

DevExpress.XtraReports.Web.ParametersPanel Namespace