Progress® Telerik® Reporting R1 2022
IReportViewerBuilder Interface
Represents a builder that provides a way to initialize the report viewer
Namespace:
Telerik.ReportViewer.MvcAssembly: Telerik.ReportViewer.Mvc (in Telerik.ReportViewer.Mvc.dll) Version: 16.0.21.1021 R1 2022
Syntax
The IReportViewerBuilder type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AccessibilityKeyMap |
Sets the key mappings used in accessibility mode.
|
| AuthenticationToken |
The encoded authentication token used to authenticate the requests.
|
| CheckedButtonClass |
Sets the class to be used by buttons in the checked state.
|
| ClientEvents |
Provides a way to initialize the event handlers of the report viewer.
|
| Deferred |
Defers the script initialization statement.
|
| DirectPrint | Obsolete.
Sets whether the viewer should use the browser's Adobe PDF plug-in for the print action.
|
| DisabledButtonClass |
Sets the class to be used by buttons in the disabled state.
|
| DocumentMapAreaPosition |
Specifies where the Document Map Area should be displayed.
Right - Displays Document Map Area on the right of the page view.
Left - Displays Document Map Area on the left of the page view.
|
| DocumentMapVisible |
Sets the viewer’s document map initial visibility state.
|
| EnableAccessibility |
Enables or disables the accessibility features of the report viewer and its contents.
|
| Id |
Each report viewer must have an id - it will be used by the initialization script
to find the element and initialize the report viewer.
|
| InitialPageAreaImageUrl |
The image URL for the PageArea background image. Used only when the parameter values are missing or invalid.
|
| KeepClientAlive |
Gets or sets a value indicating whether the client will be kept alive.
When set to true a request will be sent to the server to stop the client from expiring, determined by the ClientSessionTimeout server configuration When set to false, the client will be left to be expired |
| PageMode |
Specifies whether the viewer is in Continuous scroll or Single page mode.
SinglePage - Displays only one report page in PageArea container
ContinuousScroll - Displays large amount of report pages by appending additional pages on demand.
|
| ParameterEditors |
Provides a way to initialize the parameter editors of the report viewer.
|
| Parameters |
The parameters options
|
| ParametersAreaPosition |
Specifies where the Parameters Area should be displayed.
Right - Displays Parameters Area on the right of the page view.
Left - Displays Parameters Area on the left of the page view.
Top - Displays Parameters Area on the top of the page view.
Bottom - Displays Parameters Area on the bottom of the page view.
|
| ParametersAreaVisible |
Sets the viewer’s parameters area initial visibility state.
|
| PersistSession |
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.
|
| PrintMode |
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.
|
| ReportResolver | Obsolete.
Sets the chain of report resolvers
|
| ReportServer |
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.
|
| ReportSource(String) |
Sets the ReportSource as String
for the report displayed in the viewer.
|
| ReportSource(ReportSource) | Obsolete.
Sets the ReportSource
for the report displayed in the viewer.
|
| ReportSource(TypeReportSource) |
Sets the ReportSource as TypeReportSource
for the report displayed in the viewer.
|
| ReportSource(UriReportSource) |
Sets the ReportSource as UriReportSource
for the report displayed in the viewer.
|
| ReportSource(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> |
| Scale |
Zoom in and out the report using the scale.
1.0 is equal to 100%, i.e. the original size of the report.
|
| ScaleMode(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.
|
| ScaleMode(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.
|
| SearchMetadataOnDemand |
Determines whether the search metadata will be delivered on demand or by default.
|
| SendEmail |
The send e-mail message options
|
| ServiceUrl |
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.
|
| TemplateUrl |
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.
|
| ViewMode(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.
|
| ViewMode(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.
|
Version Information
Supported in: 1.0.1