Progress® Telerik® Reporting R3 2017

IReportViewerBuilder Interface

Represents a builder that provides a way to initialize the report viewer

Namespace:  Telerik.ReportViewer.Mvc
Assembly:  Telerik.ReportViewer.Mvc (in Telerik.ReportViewer.Mvc.dll)

Syntax

public interface IReportViewerBuilder

The IReportViewerBuilder type exposes the following members.

Methods

  NameDescription
Public methodAccessibilityKeyMap
Sets the key mappings used in accessibility mode.
Public methodAuthenticationToken
The encoded authentication token used to authenticate the requests.
Public methodCheckedButtonClass
Sets the class to be used by buttons in the checked state.
Public methodClientEvents
Provides a way to initialize the event handlers of the report viewer.
Public methodDeferred
Defers the script initialization statement.
Public methodDirectPrintObsolete.
Sets whether the viewer should use the browser's Adobe PDF plug-in for the print action.
Public methodDisabledButtonClass
Sets the class to be used by buttons in the disabled state.
Public methodDocumentMapVisible
Sets the viewer’s document map initial visibility state.
Public methodEnableAccessibility
Enables or disables the accessibility features of the report viewer and its contents.
Public methodId
Each report viewer must have an id - it will be used by the initialization script to find the element and initialize the report viewer.
Public methodParameterEditors
Provides a way to initialize the parameter editors of the report viewer.
Public methodParametersAreaVisible
Sets the viewer’s parameters area initial visibility state.
Public methodPersistSession
Sets whether the viewer’s client session to be persisted between the page’s refreshes(ex. postback). The session is stored in the browser’s sessionStorage and is available for the duration of the page session.
Public methodPrintMode
Sets the print mode of the viewer. Three modes exist currently: AutoSelect - Specifies that the viewer should automatically determine how to print: through the browser's PDF plug-in or through export to a PDF file. ForcePDFPlugin - Specifies that the viewer should always use the PDF plugin regardless of the browser's version and settings. ForcePDFFile - Specifies that the viewer should always export the report document to PDF format with the 'print' script enabled.
Public methodReportResolverObsolete.
Sets the chain of report resolvers
Public methodReportServer
The connection data of the report server that hosts the reports. For more information see http://www.telerik.com/help/reporting/html5-report-viewer-howto-use-it-with-reportserver.html.
Public methodReportSource(String)
Sets the ReportSource as String for the report displayed in the viewer.
Public methodReportSource(ReportSource)Obsolete.
Sets the ReportSource for the report displayed in the viewer.
Public methodReportSource(TypeReportSource)
Sets the ReportSource as TypeReportSource for the report displayed in the viewer.
Public methodReportSource(UriReportSource)
Sets the ReportSource as UriReportSource for the report displayed in the viewer.
Public methodReportSource(String, IDictionaryString, Object)
Sets the ReportSource as String for the report displayed in the viewer. Sets the parameters of the ReportSource as IDictionary<System.String, System.Object>
Public methodScale
Zoom in and out the report using the scale. 1.0 is equal to 100%, i.e. the original size of the report.
Public methodScaleMode(ScaleMode)
Sets the scale mode of the viewer. Three modes exist currently: FitPage - The whole report will fit on the page (will zoom in or out), regardless of its width and height. FitPageWidth - The report will be zoomed in or out so that the width of the screen and the width of the report match. Specific - Uses the scale to zoom in and out the report.
Public methodScaleMode(ScaleModes)Obsolete.
Sets the scale mode of the viewer. Three modes exist currently: FIT_PAGE - The whole report will fit on the page (will zoom in or out), regardless of its width and height. FIT_PAGE_WIDTH - The report will be zoomed in or out so that the width of the screen and the width of the report match. SPECIFIC - Uses the scale to zoom in and out the report.
Public methodServiceUrl
The url of the service which will provide the report viewer with reports. The service must be properly configured so that the report viewer can successfully communicate with the server. For more information on how to configure the service please check http://www.telerik.com/help/reporting/telerik-reporting-rest-conception.html.
Public methodTemplateUrl
The url for the report viewer template. The template can be edited - new functionalities can be added and not needed ones can be removed. For more information please check http://www.telerik.com/help/reporting/html5-report-viewer-templates.html.
Public methodViewMode(ViewMode)
Specifies whether the viewer is in interactive or print preview mode. PrintPreview - Displays the paginated report as if it is printed on paper. Interactivity is not enabled. Interactive - Displays the report in its original width and height with no paging. Additionally interactivity is enabled.
Public methodViewMode(ViewModes)Obsolete.
Specifies whether the viewer is in interactive or print preview mode. PRINT_PREVIEW - Displays the paginated report as if it is printed on paper. Interactivity is not enabled. INTERACTIVE - Displays the report in its original width and height with no paging. Additionally interactivity is enabled.
Top

See Also