Interface IReportViewerBuilder
Represents a builder that provides a way to initialize the report viewer
Namespace: Telerik.ReportViewer.Mvc
Assembly: Telerik.ReportViewer.Mvc.dll
Syntax
public interface IReportViewerBuilderMethods
AccessibilityKeyMap(AccessibilityKeyMap)
Sets the key mappings used in accessibility mode.
Declaration
IReportViewerBuilder AccessibilityKeyMap(AccessibilityKeyMap keyMap)Parameters
| AccessibilityKeyMap keyMap |
Returns
| IReportViewerBuilder |
AuthenticationToken(String)
The encoded authentication token used to authenticate the requests.
Declaration
IReportViewerBuilder AuthenticationToken(string token)Parameters
|
System.String
token
|
Returns
| IReportViewerBuilder |
CheckedButtonClass(String)
Sets the class to be used by buttons in the checked state.
Declaration
IReportViewerBuilder CheckedButtonClass(string checkedButtonClass)Parameters
|
System.String
checkedButtonClass
|
Returns
|
IReportViewerBuilder
|
ClientEvents(Action<IClientEventsBuilder>)
Provides a way to initialize the event handlers of the report viewer.
Declaration
IReportViewerBuilder ClientEvents(Action<IClientEventsBuilder> clientEventsBuilder)Parameters
|
System.Action<IClientEventsBuilder>
clientEventsBuilder
|
Returns
| IReportViewerBuilder |
Deferred()
Defers the script initialization statement.
Declaration
IReportViewerBuilder Deferred()Returns
| IReportViewerBuilder |
DirectPrint(Boolean)
Sets whether the viewer should use the browser's Adobe PDF plug-in for the print action.
Declaration
[Obsolete("Telerik.ReportViewer.Mvc.IReportViewerBuilder.DirectPrint(bool) is now obsolete. Please use Telerik.ReportViewer.Mvc.IReportViewerBuilder.PrintMode(Telerik.ReportViewer.Mvc.PrintMode) overload instead.")]
IReportViewerBuilder DirectPrint(bool directPrint)Parameters
|
System.Boolean
directPrint
|
Returns
|
IReportViewerBuilder
|
DisabledButtonClass(String)
Sets the class to be used by buttons in the disabled state.
Declaration
IReportViewerBuilder DisabledButtonClass(string disabledButtonClass)Parameters
|
System.String
disabledButtonClass
|
Returns
|
IReportViewerBuilder
|
DocumentMapAreaPosition(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.
Declaration
IReportViewerBuilder DocumentMapAreaPosition(DocumentMapAreaPosition documentMapAreaPosition)Parameters
|
DocumentMapAreaPosition
documentMapAreaPosition
|
Returns
| IReportViewerBuilder |
DocumentMapVisible(Boolean)
Sets the viewer’s document map initial visibility state.
Declaration
IReportViewerBuilder DocumentMapVisible(bool visible)Parameters
|
System.Boolean
visible
|
Returns
|
IReportViewerBuilder
|
EnableAccessibility(Boolean)
Enables or disables the accessibility features of the report viewer and its contents.
Declaration
IReportViewerBuilder EnableAccessibility(bool enable)Parameters
|
System.Boolean
enable
|
Returns
| IReportViewerBuilder |
Id(String)
Each report viewer must have an id - it will be used by the initialization script to find the element and initialize the report viewer.
Declaration
IReportViewerBuilder Id(string id)Parameters
|
System.String
id
|
Returns
| IReportViewerBuilder |
InitialPageAreaImageUrl(String)
The image URL for the PageArea background image. Used only when the parameter values are missing or invalid.
Declaration
IReportViewerBuilder InitialPageAreaImageUrl(string initialPageAreaImageUrl)Parameters
|
System.String
initialPageAreaImageUrl
|
Returns
| IReportViewerBuilder |
KeepClientAlive(Boolean)
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
Declaration
IReportViewerBuilder KeepClientAlive(bool keepClientAlive)Parameters
|
System.Boolean
keepClientAlive
|
Returns
| IReportViewerBuilder |
PageMode(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.
Declaration
IReportViewerBuilder PageMode(PageMode pageMode)Parameters
|
PageMode
pageMode
|
Returns
| IReportViewerBuilder |
ParameterEditors(Action<IParameterEditorsBuilder>)
Provides a way to initialize the parameter editors of the report viewer.
Declaration
IReportViewerBuilder ParameterEditors(Action<IParameterEditorsBuilder> parameterEditorsBuilder)Parameters
|
System.Action<IParameterEditorsBuilder>
parameterEditorsBuilder
|
Returns
| IReportViewerBuilder |
Parameters(Parameters)
The parameters options
Declaration
IReportViewerBuilder Parameters(Parameters parametersOptions)Parameters
|
Parameters
parametersOptions
|
Returns
| IReportViewerBuilder |
ParametersAreaPosition(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.
Declaration
IReportViewerBuilder ParametersAreaPosition(ParametersAreaPosition parametersAreaPosition)Parameters
|
ParametersAreaPosition
parametersAreaPosition
|
Returns
| IReportViewerBuilder |
ParametersAreaVisible(Boolean)
Sets the viewer’s parameters area initial visibility state.
Declaration
IReportViewerBuilder ParametersAreaVisible(bool visible)Parameters
|
System.Boolean
visible
|
Returns
|
IReportViewerBuilder
|
PersistSession(Boolean)
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.
Declaration
IReportViewerBuilder PersistSession(bool persistSession)Parameters
|
System.Boolean
persistSession
|
Returns
| IReportViewerBuilder |
PrintMode(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.
Declaration
IReportViewerBuilder PrintMode(PrintMode printMode)Parameters
|
PrintMode
printMode
Specifies the print mode of the viewer. |
Returns
| IReportViewerBuilder |
ReportResolver(IReportResolver)
Sets the chain of report resolvers
Declaration
[Obsolete]
IReportViewerBuilder ReportResolver(IReportResolver resolver)Parameters
|
IReportResolver
resolver
|
Returns
| IReportViewerBuilder |
ReportServer(ReportServer)
The connection data of the report server that hosts the reports. For more information see https://www.telerik.com/help/reporting/html5-report-viewer-howto-use-it-with-reportserver.html.
Declaration
IReportViewerBuilder ReportServer(ReportServer reportServer)Parameters
|
ReportServer
reportServer
|
Returns
| IReportViewerBuilder |
ReportSource(String)
Sets the ReportSource as System.String for the report displayed in the viewer.
Declaration
IReportViewerBuilder ReportSource(string report)Parameters
|
System.String
report
|
Returns
| IReportViewerBuilder |
ReportSource(String, IDictionary<String, Object>)
Sets the ReportSource as System.String for the report displayed in the viewer. Sets the parameters of the ReportSource as System.Collections.Generic.IDictionary<TKey, TValue>
Declaration
IReportViewerBuilder ReportSource(string report, IDictionary<string, object> parameters)Parameters
|
System.String
report
|
|
System.Collections.Generic.IDictionary<System.String, System.Object>
parameters
|
Returns
| IReportViewerBuilder |
ReportSource(ReportSource)
Sets the ReportSource for the report displayed in the viewer.
Declaration
[Obsolete]
IReportViewerBuilder ReportSource(ReportSource reportSource)Parameters
|
ReportSource
reportSource
|
Returns
| IReportViewerBuilder |
ReportSource(TypeReportSource)
Sets the ReportSource as TypeReportSource for the report displayed in the viewer.
Declaration
IReportViewerBuilder ReportSource(TypeReportSource typeReportSource)Parameters
|
TypeReportSource
typeReportSource
|
Returns
| IReportViewerBuilder |
ReportSource(UriReportSource)
Sets the ReportSource as UriReportSource for the report displayed in the viewer.
Declaration
IReportViewerBuilder ReportSource(UriReportSource uriReportSource)Parameters
|
UriReportSource
uriReportSource
|
Returns
| IReportViewerBuilder |
Scale(Double)
Zoom in and out the report using the scale. 1.0 is equal to 100%, i.e. the original size of the report.
Declaration
IReportViewerBuilder Scale(double scale)Parameters
|
System.Double
scale
|
Returns
| IReportViewerBuilder |
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.
Declaration
IReportViewerBuilder ScaleMode(ScaleMode scaleMode)Parameters
|
ScaleMode
scaleMode
|
Returns
| IReportViewerBuilder |
ScaleMode(ScaleModes)
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.
Declaration
[Obsolete("Telerik.ReportViewer.Mvc.IReportViewerBuilder.ScaleMode(Telerik.ReportViewer.Mvc.ScaleModes) is now obsolete. Please use Telerik.ReportViewer.Mvc.IReportViewerBuilder.ScaleMode(Telerik.ReportViewer.Mvc.ScaleMode) overload instead.")]
IReportViewerBuilder ScaleMode(ScaleModes scaleMode)Parameters
|
ScaleModes
scaleMode
|
Returns
| IReportViewerBuilder |
SearchMetadataOnDemand(Boolean)
Determines whether the search metadata will be delivered on demand or by default.
Declaration
IReportViewerBuilder SearchMetadataOnDemand(bool enable)Parameters
|
System.Boolean
enable
|
Returns
| IReportViewerBuilder |
Remarks
Enabling search will notify the report engine to produce search metadata while rendering the report. This metadata is used by the report viewer in search dialog and in the report viewer area for highlighting the found and selected items. Default value: false
SendEmail(SendEmail)
The send e-mail message options
Declaration
IReportViewerBuilder SendEmail(SendEmail sendEmailOptions)Parameters
|
SendEmail
sendEmailOptions
|
Returns
| IReportViewerBuilder |
ServiceUrl(String)
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 https://docs.telerik.com/reporting/embedding-reports/host-the-report-engine-remotely/telerik-reporting-rest-services/overview.
Declaration
IReportViewerBuilder ServiceUrl(string serviceUrl)Parameters
|
System.String
serviceUrl
|
Returns
| IReportViewerBuilder |
TemplateUrl(String)
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 https://docs.telerik.com/reporting/embedding-reports/display-reports-in-applications/web-application/html5-report-viewer/customizing/styling-and-appearance/templates-structure.
Declaration
IReportViewerBuilder TemplateUrl(string templateUrl)Parameters
|
System.String
templateUrl
|
Returns
| IReportViewerBuilder |
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.
Declaration
IReportViewerBuilder ViewMode(ViewMode viewMode)Parameters
|
ViewMode
viewMode
|
Returns
| IReportViewerBuilder |
ViewMode(ViewModes)
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.
Declaration
[Obsolete("Telerik.ReportViewer.Mvc.IReportViewerBuilder.ViewMode(Telerik.ReportViewer.Mvc.ViewModes) is now obsolete. Please use Telerik.ReportViewer.Mvc.IReportViewerBuilder.ViewMode(Telerik.ReportViewer.Mvc.ViewMode) overload instead.")]
IReportViewerBuilder ViewMode(ViewModes viewMode)Parameters
|
ViewModes
viewMode
|
Returns
| IReportViewerBuilder |