Standalone Report Parameters Panel - ASP.NET Core Applications

• Jun 05, 2024
• 3 minutes to read

The Standalone Report Parameters Panel is a component that creates a layout with editors for report parameters. It retrieves information on report parameters from a DevExpress report instance passed from the backend.

Use this component to programmatically create a report, then export or email it without showing a preview to the end user. The component reduces memory usage by eliminating the need to generate report preview and sending it to the client application.

The Standalone Report Parameters Panel component is based on the Parameters Panel of the DevExpress Web Report Viewer component. Public properties and events are similar to the properties and events implemented in the Web Document Viewer component.

View Example: Reporting for ASP.NET Core - Standalone Report Parameters Panel

Standalone Report Parameters Panel Component Settings

Standalone Report Parameters Panel API

Client-Side API

The following types and members implement client-side Standalone Report Parameters Panel functionality:

JSReportParametersPanel

A class that triggers events for the Standalone Report Parameters Panel and serves as the sender in callback functions.

JSReportParametersPanel.GetParametersModel

Allows you to access the report parameters client-side model.

JSReportParametersPanel.SerializeParametersState

Serializes parameter information from the Standalone Report Parameters Panel to a JSON string.

ParametersPanelModelBase

A base class that defines common properties and methods for client models of report parameters.

ParametersPanelStandalone

Client-side model for the Standalone Report Parameters Panel component.

Server API

The component events (callbacks) are defined using ReportParametersPanelClientSideEventsBuilder methods:

• BeforeRender(String)
• CustomizeLocalization(String)
• CustomizeParameterEditors(String)
• CustomizeParameterLookUpSource(String)
• OnInitializing(String)
• OnServerError(String)
• ParametersInitialized(String)
• ParametersReset(String)

Classes related to the server-side model:

IReportParametersPanelClientSideModelGenerator

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

ReportParametersPanelModel

A class that is the server-side model for the Standalone Report Parameters Panel.

This service allows you to pass a string obtained from the client’s SerializeParametersState method. The return object is a report instance with the applied parameters:

IReportParametersSerializer

Defines methods that enable you to deserialize parameters received from the Standalone Report Parameters Panel component and apply parameters to a report instance.

Panel Builder

ParameterPanelFluentBuilder

Contains methods that allow you to customize the Parameters panel.

Add a Standalone Report Parameters Panel to Your Application

Review the following help topic to configure the Standalone Report Parameters Panel component in your ASP.NET Core application:

• Standalone Report Parameters Panel in ASP.NET Core Applications

Apply the Parameter Values

Review the following help topic to find out how to get parameter values on the server and apply them to the report:

• How to Use Parameter Values from the Standalone Report Parameters Panel (ASP.NET Core App)