Native Blazor Report Viewer Options Overview
Below is a list of all options available during the initialization of the native Blazor Report Viewer.
Options
Property | Description |
---|---|
ServiceType |
enum, required; Specifies the type of service that the report viewer will connect to. Available options are:
|
ServiceUrl |
string, required if ServiceType is REST; Sets the address of the Report REST Service; |
ReportSource |
ReportSourceOptions, required; Specifies the report and initial report parameter values to be displayed in the report viewer. The ReportSourceOptions object is made up of the following properties:
To set the ReportSource to a physical (TRDP/TRDX/TRBP) file, provide a relative path to the Report property of the ReportSourceOptions object.
To set the ReportSource to a type definition:
|
ReportViewerSettings |
RenderFragment, optional Defines a renderfragment that contains all settings for the Report Viewer. The currently available settings are:
|
ScaleMode |
enum, optional; Sets how the report pages to be scaled. Available options are:
|
Scale |
double, optional; Sets the scale factor for the report pages. The scale takes effect when the ScaleMode is set to Specific. Default value is 1.0 (100%); the original size of the report |
ViewMode |
Sets if the report is displayed in interactive mode or in print preview. The available values are:
|
PageMode |
Sets if the report is displayed in Single page or Continuous scroll mode. The available values are:
|
PrintMode |
Specifies how the viewer should print reports. The available values are:
|
ParametersAreaVisible |
boolean, optional; Determines whether the viewer's parameters area is displayed if any parameter editor exists. Default value: false |
DocumentMapVisible |
boolean, optional; Determines whether the viewer's document map is displayed if any bookmark is defined. Default value: false |
KeepClientAlive |
boolean, optional; Determines whether the client will be kept alive. When set to true, expiration of the client will be prevented by continually sending a request to the server, determined by the Reporting REST service's ClientSessionTimeout. Default value: true |
EnableSendEmail |
boolean, optional; Determines whether the Send Email functionality is enabled. If set to false the Send Email button will not be displayed in the toolbar. Default value: true |
Width |
string, optional; The width of the component. Default value: 100% |
Height |
string, optional; The height of the component. Default value: 700px |
Tools |
List<IReportViewerTool>, optional; A collection of tools that will be displayed in the toolbar. By default populates all available tools as listed in the Customize the Toolbar of the Blazor Native Report Viewer article. |
AuthenticationToken |
string, optional; If provided, a Bearer token will be set in the Authorization header for requests to the REST service. The token is not sent only when requesting document resources. The reason is that the resources like images are referenced with relative URLs in the HTML of the report document, hence the requests for them are made by the browser. |