Progress® Telerik® Reporting R2 2021

ReportViewer Class

Represents the ReportViewer control.

Inheritance Hierarchy

SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      Telerik.ReportViewer.Html5.WebFormsReportViewer

Namespace:  Telerik.ReportViewer.Html5.WebForms
Assembly:  Telerik.ReportViewer.Html5.WebForms (in Telerik.ReportViewer.Html5.WebForms.dll)

Syntax

public class ReportViewer : WebControl

The ReportViewer type exposes the following members.

Constructors

  NameDescription
Public methodReportViewer
Initializes a new instance of the ReportViewer class
Top

Properties

  NameDescription
Public propertyAccessibilityKeyMap
Gets or sets the key mappings used in accessibility mode.
Public propertyAuthenticationToken
Gets or sets the encoded authentication token used to authenticate the requests.
Public propertyCheckedButtonClass
Gets or sets the class to be used by buttons in the checked state.
Public propertyClientEvents
Gets or sets the event handlers of the report viewer.
Public propertyDeferred
Gets or sets a value indicating whether script initialization statement will be deferred.
Public propertyDisabledButtonClass
Gets or sets the class to be used by buttons in the disabled state.
Public propertyDocumentMapAreaPosition
Gets or sets the viewer's document map area position.
Public propertyDocumentMapVisible
Gets or sets a value indicating whether the viewer’s document map is initially visible.
Public propertyEnableAccessibility
Gets or sets a value indicating whether the accessibility features of the report viewer and its contents are enabled.
Public propertyHeight (Overrides WebControlHeight.)
Public propertyInitialPageAreaImageUrl
Gets or sets the image URL for the PageArea background image. Used only when the parameter values are missing or invalid.
Public propertyKeepClientAlive
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

Public propertyPageMode
Gets or sets the viewer's page mode. SinglePage - Displays only one report page in PageArea container. ContinuousScroll - Displays large amount of report pages by appending additional pages on demand.
Public propertyPageNumber
Gets or sets the current page number of the report.
Public propertyParameterEditors
Gets or sets represents a control that provides a way to initialize the parameter editors of the report viewer.
Public propertyParameters
Gets or sets contains the parameters settings configuration. The Editors object, that defind the parameters editors types .
Public propertyParametersAreaPosition
Gets or sets the viewer's parameters area position.
Public propertyParametersAreaVisible
Gets or sets a value indicating whether the viewer’s parameters area is initially visible.
Public propertyPersistSession
Gets or sets a value indicating whether the viewer’s client state will be persisted between the page refreshes (ex. postbacks). The state is stored in the browser’s sessionStorage and is available for the duration of the page session.
Public propertyPrintMode
Gets or 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 propertyReportServer
Gets or sets the connection data of the report server that hosts the report. The report server should have its Guest account enabled and with configured permissions for accessing the report. For more information see http://www.telerik.com/help/reporting/html5-report-viewer-howto-use-it-with-reportserver.html.
Public propertyReportSource
Gets or sets the ReportSource for the report displayed in the viewer.
Public propertyScale
Gets or sets zoom level of the report. 1.0 is equal to 100%, i.e. the original size of the report.
Public propertyScaleMode
Gets or 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 propertySearchMetadataOnDemand
Gets or sets a value indicating whether the search metadata will be delivered on demand or by default.
Public propertySendEmail
Gets or sets contains the send e-mail functionality configuration. The enabled property, the preselected rendering Format, from and to e-mail addresses.
Public propertyServiceUrl
Gets or sets 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 propertyTemplateUrl
Gets or sets 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 propertyViewMode
Gets or sets the viewer's view 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 propertyWidth (Overrides WebControlWidth.)
Top

Methods

  NameDescription
Protected methodLoadViewState (Overrides WebControlLoadViewState(Object).)
Protected methodOnInit (Overrides ControlOnInit(EventArgs).)
Protected methodOnPreRender (Overrides ControlOnPreRender(EventArgs).)
Protected methodRender (Overrides WebControlRender(HtmlTextWriter).)
Protected methodRenderContents (Overrides WebControlRenderContents(HtmlTextWriter).)
Public methodRenderDesignTimeHtml
Public methodToString (Overrides ObjectToString.)
Top

Version Information

Supported in: 1.0.1

See Also

In this article
Not finding the help you need?