- Core
- Exports
- Interops
- ReportDesigner
-
ReportViewer
- ReportViewer.CancellationToken
- ReportViewer.ExportResult
- ReportViewer.FontDescriptor
- ReportViewer.HistoryApi
- ReportViewer.MouseMode
- ReportViewer.Range
- ReportViewer.Rect
- ReportViewer.ReportSettings
- ReportViewer.SearchResult
- ReportViewer.SearchStatus
- ReportViewer.Toolbar
- ReportViewer.ViewMode
- ReportViewer.Viewer
- ReportViewer.ViewerOptions
- ReportViewer.ViewerStatus
- ReportViewer.ZoomMode
ReportViewer
Namespace: ReportViewer
Table of contents
Enumerations
Classes
Interfaces
Type aliases
- DocumentLoadEventArgs
- ExportSettings
- LoadResult
- PanelsLocation
- ParameterPanelLocation
- ReportLoadEventArgs
- SearchOptions
- ShowParametersOnOpen
- ToolbarItem
- ToolbarLayout
- ViewerMouseMode
- ViewerRenderMode
- ViewerViewMode
- ViewerZoomMode
Type aliases
DocumentLoadEventArgs
Ƭ DocumentLoadEventArgs: Object
Defines the 'documentLoaded' event arg.
Type declaration
| Name | Type | Description |
|---|---|---|
cancelled? |
boolean |
true if document rendering was cancelled |
pageCount |
number |
number of document pages. |
ExportSettings
Ƭ ExportSettings: Record<string, string | boolean | number | null>
Initial settings for export panel:
var exportSettings = {
filename: 'NewFile'
};
LoadResult
Ƭ LoadResult: { document: IDocument ; status: "loaded" } | { details?: string ; message: string ; status: "error" } | { status: "cancelled" }
PanelsLocation
Ƭ PanelsLocation: "sidebar" | "toolbar"
Viewer panels location
ParameterPanelLocation
Ƭ ParameterPanelLocation: "auto" | "default" | "top" | "bottom"
Parameters view/panel location
ReportLoadEventArgs
Ƭ ReportLoadEventArgs: Object
'reportLoaded' event arg
Type declaration
| Name | Type | Description |
|---|---|---|
report |
PageReport |
The loaded report |
SearchOptions
Ƭ SearchOptions: Object
Defines the argument type for the ReportViewer.search method.
Type declaration
| Name | Type | Description |
|---|---|---|
matchCase? |
boolean |
Case-sensitive search. |
searchBackward? |
boolean |
Search backward from the current position. |
startPage? |
number |
The page to start the search from. |
text |
string |
Text to search for. |
wholeWord? |
boolean |
Match whole word. |
ShowParametersOnOpen
Ƭ ShowParametersOnOpen: "always" | "auto"
Parameters view/panel open behaviour
ToolbarItem
Ƭ ToolbarItem: Object
Defines the toolbar item settings and behavior.
Type declaration
| Name | Type |
|---|---|
checked? |
boolean |
enabled? |
boolean |
icon? |
Icon |
iconCssClass? |
string |
key |
string |
text? |
string |
title? |
string |
action? |
(curr?: ToolbarItem) => void | Partial<ToolbarItem> |
onUpdate? |
(args: ChangedEventArgs, curr: ToolbarItem) => void | Partial<ToolbarItem> |
ToolbarLayout
Ƭ ToolbarLayout: Object
Describes the toolbar items layout (order and visibility) for different view models.
Type declaration
| Name | Type | Description |
|---|---|---|
default? |
string[] |
Default (desktop) view mode. Also applied when other modes are not specified. |
fullscreen? |
string[] |
The layout for the full-screen mode. |
mobile? |
string[] |
The toolbar layout for mobile devices. |
ViewerMouseMode
Ƭ ViewerMouseMode: "Pan" | "Selection"
Viewer mouse mode
ViewerRenderMode
Ƭ ViewerRenderMode: "Galley" | "Paginated"
Viewer render mode
ViewerViewMode
Ƭ ViewerViewMode: "Continuous" | "SinglePage"
Viewer view mode
ViewerZoomMode
Ƭ ViewerZoomMode: "FitToWidth" | "FitPage" | number
Viewer zoom mode