Standalone Report Parameters Panel in Blazor Server Applications
- 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.
Use this component to programmatically create a report, then export or email it without showing a preview to the end user.
The Standalone Report Parameters Panel component is based on the Parameters Panel part of the Document Viewer component. Public properties and events are similar to the properties and events implemented in the Document Viewer component.
The following code example is a sample markup on a razor page with the Standalone Report Parameters Panel component:
@using DevExpress.Blazor.Reporting
<DxReportParametersPanel ReportName="TestReport" Height="1000px" Width="650px">
<DxReportParametersPanelRequestOptions HandlerUri="DXXRDV"/>
<DxReportParametersPanelCallbacks BeforeRender="ReportingPanel.beforeRender"/>
</DxReportParametersPanel>
Standalone Report Parameters Panel Component Settings
The DxReportParametersPanel is the Standalone Report Parameters Panel component class in Blazor Server applications. The class exposes properties that are the top-level options for the Blazor component.
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
- This class 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.
Add a Standalone Report Parameters Panel to Your Application
Review the following help topic to configure the Standalone Report Parameters Panel component in your DevExpress Blazor Server application:
Apply the Parameter Values
Review the following help topic to learn how to get parameter values on the server and apply them to the report: