New to Telerik Reporting? Download free 30-day trial

Methods of the HTML5 Report Viewer

Method Description
accessibilityKeyMap() Gets the shortcut keys used when the report viewer is in accessible mode (has its enableAccessibility set to true. The keys in the map are listed below:
Key Default Value Description
CONFIRM_KEY 13 ('enter') Key for triggering the actions in the report content and previewing the report from the Preview button in parameters area, if available.
MENU_AREA_KEY 77 ('m') Key for moving the focus to the menu area, if visible.
CONTENT_AREA_KEY 67 ('c') Key for moving the focus to the report content area, if visible.
PARAMETERS_AREA_KEY 80 ('p') Key for moving the focus to the parameters area, if visible.
DOCUMENT_MAP_AREA_KEY 68 ('d') Key for moving the focus to the document map area, if visible.
accessibilityKeyMap(keyMap) Sets the shortcut keys used when the report viewer is in accessible mode. It is recommended to set the new key map when the report rendering is complete, because the accessibility routines require the report viewer template to be loaded.
authenticationToken(token) Sets the viewer’s authentication token.
bind(eventName, eventHandler) Binds event handlers to the specified event.
clearReportSource() Clears the current reportSource from the viewer internal state and from its persisted session in the browser. Called in order to force the viewer to respect the newly set reportSource on the next postback.
currentPage() Gets the viewer’s current page that is displayed.
getReportParameters() Gets an immutable array of name-value objects representing the current evaluated report parameters.
pageCount() Gets the total page count of viewer’s currently displayed report.
refreshReport() Reloads/refreshes the current report.
reportSource() Gets the current ReportSource - report and parameters.
reportSource(rs) Sets the report source - report and parameters. Automatically reloads the report (if any) into the view.
scale() Gets the viewer’s scale factor and scale mode. For more information please see jQuery.fn.telerik_ReportViewer’s scale and scaleMode options in Report Viewer Initialization.
scale(scale) Sets the scale factor and scale mode. For more information please see jQuery.fn.telerik_ReportViewer’s scale and scaleMode options in Report Viewer Initialization.
unbind(eventName) Unbinds all event handlers from the specified event.
unbind(eventName, eventHandler) Unbinds event handlers from the specified event.
viewMode() Gets the current view mode. For more information please see jQuery.fn.telerik_ReportViewer’s viewMode option in Report Viewer Initialization.
viewMode(vm) Sets the view mode and automatically reloads the current report (if any) into the new view;
pageMode() Gets the current page mode. For more information please see jQuery.fn.telerik_ReportViewer’s pageMode option in Report Viewer Initialization.
pageMode(psm) Sets the page mode and automatically reloads the current report (if any) into the new view.

See Also

In this article