Progress® Telerik® Reporting R3 2017

Methods

Method

Description

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.

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;

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.

pageCount()

Gets the total page count of viewer’s currently displayed report.

currentPage()

Gets the viewer’s current page that is displayed.

authenticationToken(token)

Sets the viewer’s authentication token.

bind(eventName, eventHandler)

Binds event handlers to the specified event. For more information please see jQuery.fn.telerik_ReportViewer’s scale and scaleMode options in Report Viewer Initialization.

unbind(eventName, eventHandler)

Unbinds event handlers from the specified event. 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. For more information please see jQuery.fn.telerik_ReportViewer’s scale and scaleMode options in Report Viewer Initialization.

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.