Namespace: ReportViewer

Table of contents

열거형

• MouseMode
• SearchStatus
• ViewMode
• ViewerStatus
• ZoomMode

클래스

• CancellationToken
• Range
• Rect
• SearchResult
• Viewer

인터페이스

• ExportResult
• FontDescriptor
• HistoryApi
• ReportSettings
• Toolbar
• ViewerOptions

유형별칭

• BuiltInUITheme
• DocumentLoadEventArgs
• ExportSettings
• LoadResult
• PanelsLocation
• ParameterPanelLocation
• ReportLoadEventArgs
• SearchOptions
• ShowParametersOnOpen
• ToolbarLayout
• UITheme
• UIThemeConfig
• ViewerMouseMode
• ViewerRenderMode
• ViewerViewMode
• ViewerZoomMode

Type aliases

BuiltInUITheme

Ƭ BuiltInUITheme: "System" | "Default" | "DefaultDark" | "DarkOled" | "HighContrast" | "HighContrastDark" | "ActiveReports" | "ActiveReportsDark"

UI theme

---

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

---

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.

---

UITheme

Ƭ UITheme: BuiltInUITheme | ColorTheme

---

UIThemeConfig

Ƭ UIThemeConfig: Object

Type declaration

Name	Type	Description
initialTheme?	string	The initial theme to be applied. default "Default"
themeSelector?	{ availableThemes?: UITheme[] ; isEnabled?: boolean }	Controls Theme Picker behavior
themeSelector.availableThemes?	UITheme[]	An array of available themes that can be picked by the user. These themes are built-in themes. default ["System", "Default", "DefaultDark", "DarkOled", "HighContrast", "HighContrastDark", "ActiveReports", "ActiveReportsDark"]
themeSelector.isEnabled?	boolean	shows Theme Picker in UI

---

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