Standalone Report Parameters Panel in Blazor Applications
- 3 minutes to read
Standalone Report Parameters Panel creates a layout with editors for report parameters. It retrieves information on report parameters from a DevExpress report instance.
Use this component to programmatically create a report, then export or email it without showing a preview to the end user.
Depending on your application type and requirements, use one of the following components:
| Component | Communication Mechanism | Requires an ASP.NET Core Backend |
|---|---|---|
| DxReportParametersPanel | SignalR | No |
| DxWasmReportParametersPanel | fetch | Yes |
For a more comprehensive overview of DevExpress Blazor Reporting components, refer to the following help topic: Blazor Reporting Components Overview.
Get Started
Review the following help topics to integrate the Standalone Report Parameters Panel component into your Blazor application:
- Add a Standalone Parameters Panel to a Blazor Web App (Interactive Server)
- Add a Standalone Report Parameters Panel to a Blazor Web App (Interactive WebAssembly) with an ASP.NET Core Backend
Apply the Parameter Values
Learn how to get parameter values on the server and apply them to a report:
Standalone Report Parameters Panel Component Settings
Blazor Server
The DxReportParametersPanel is the Standalone Report Parameters Panel component class for Blazor Server applications.
The nested options are defined in the following classes:
- DxReportParametersPanelRequestOptions
- A nested component that allows you to specify where to send requests from the Standalone Report Parameters Panel.
- DxReportParametersPanelCallbacks
- Specifies client-side event handler functions for the Standalone Report Parameters Panel in Blazor applications.
Blazor WebAssembly Hosted
The DxWasmReportParametersPanel is the Standalone Report Parameters Panel component class for Blazor WebAssembly Hosted applications.
The nested options are defined in the following classes:
- DxWasmReportParametersPanelRequestOptions
- A nested component that allows you to specify where to send requests from the Standalone Report Parameters Panel.
- DxReportParametersPanelCallbacks
- Specifies client-side event handler functions for the Standalone Report Parameters Panel in Blazor applications.
Standalone Report Parameters Panel API
Client-Side API
The following types and members implement the 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
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.