ReportViewer Class

Inheritance

object

ComponentBase

ReportViewer

Implements

Namespace: GrapeCity.ActiveReports.Blazor.Viewer

Assembly: MESCIUS.ActiveReports.Blazor.Viewer.dll

Syntax

public class ReportViewer : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IAsyncDisposable

Constructors

Name	Description
ReportViewer()

Properties

Name	Description
Action	Gets or sets the callback invoked before the Viewer opens a hyperlink, bookmark link, drill down report, or toggles report control visibility.
AutoBackgroundColor	Gets a value indicating whether the view area background color is filled with the report body color.
AvailableExports	Gets or sets the array of export types available via the Export functionality of the Viewer.
DefaultExportSettings	Gets or sets the object containing custom default export settings. Use to set default value and visibility of any field in the export panel.
DisplayMode	Gets or sets the page display mode.
DocumentLoaded	Gets or sets the callback invoked when a document is fully loaded on the server.
Error	Gets or sets the callback invoked when an error occurs during the process of displaying the report.
Height	Gets or sets the height of the Viewer component.
HideErrors	Gets or sets whether to show errors in the Viewer.
InitialZoomMode	Gets or sets the initial zoom mode.
InitialZoomPercentage	Gets or sets the initial zoom value in percentage.
Locale	Gets or sets the locale used for displaying the Viewer.
LocaleData	Gets or sets the JSON containing the localization strings.
LocaleUri	Gets or sets the URL of the file containing the localization strings.
OnAction	Gets or sets the callback that is triggered before the Viewer executes an action.
PanelsLocation	Gets or sets the position of panels (search, parameters etc.): 'toolbar' or 'sidebar'.
Parameters	Gets or sets the array of name-value pairs that describe the parameters values used to run the report.
ParametersPanelSettings	Gets or sets the parameters panel settings.
RenderFormat	Gets or sets the report render mode.
RenderMode	Gets or sets the initial render mode: 'Paginated' or 'Galley'.
ReportItemsStyles	Gets or sets the custom CSS styles that will be applied to the report items.
ReportLoaded	Gets or sets the callback invoked when the Viewer obtains information about the requested report.
ReportName	Gets or sets the name of the report to be shown by the Viewer.
ReportService	Gets or sets the settings for connecting to the Web API.
Sidebar	Gets the viewer's sidebar, used to toggle its visibility.
Themes	Gets or sets the UI theme settings for customizing the appearance of the viewer.
Toolbar	Gets the viewer's toolbar, used to add custom toolbar elements or remove existing ones.
ViewerInitialized	Gets or sets the callback that is invoked when the Viewer is initialized.
Width	Gets or sets the width of the Viewer component.

Methods

Name	Description
BackToParent()	Makes the viewer display the parent report of the drill-down report.
BuildRenderTree(RenderTreeBuilder)
CurrentPage()	Gets the currently displayed page number.
Export(ExportTypes, Action<string>, bool, Dictionary<string, string>, Func<bool>)	Exports the currently displayed report.
GetTheme()	Gets the current UI theme of the viewer.
GetToc()	Gets the report table of contents (TOC).
GoToPage(int)	Makes the viewer to display the specific page. Page numeration starts with 1.
OnAfterRenderAsync(bool)
OpenReport(string, Parameter[])	Opens a report.
PageCount()	Gets the page count of the currently displayed report.
Print()	Prints the currently displayed report, if any.
Refresh()	Refreshes the report.
Render(IJSRuntime, string, InitializationOptions)	Renders the viewer to an element.
Search(string, SearchOptions, Action<List<SearchResult>>)	Performs a search of a specific term with specific search options (match case, whole word) and invokes the callback with the search result passed.
SetTheme(ColorTheme)	Sets the UI theme for the viewer.