Class ReportViewer

Represents the ReportViewer control.

Inheritance

System.Object

ReportViewer

Namespace: Telerik.ReportViewer.Html5.WebForms

Assembly: Telerik.ReportViewer.Html5.WebForms.dll

Syntax

public class ReportViewer : WebControl

Constructors

ReportViewer()

Declaration

public ReportViewer()

Properties

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.

Declaration

public PageMode PageMode { get; set; }

Property Value

PageMode

PageNumber

Gets or sets the current page number of the report.

Declaration

public int PageNumber { get; set; }

Property Value

System.Int32

ParameterEditors

Gets or sets represents a control that provides a way to initialize the parameter editors of the report viewer.

Declaration

public ParameterEditors ParameterEditors { get; set; }

Property Value

ParameterEditors

Parameters

Gets or sets contains the parameters settings configuration. The Editors object, that defind the parameters editors types .

Declaration

public Parameters Parameters { get; set; }

Property Value

Parameters

ParametersAreaPosition

Gets or sets the viewer's parameters area position.

Declaration

public ParametersAreaPosition ParametersAreaPosition { get; set; }

Property Value

ParametersAreaPosition

ParametersAreaVisible

Gets or sets a value indicating whether the viewer’s parameters area is initially visible.

Declaration

public bool ParametersAreaVisible { get; set; }

Property Value

System.Boolean

PersistSession

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.

Declaration

public bool PersistSession { get; set; }

Property Value

System.Boolean

PrintMode

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.

Declaration

public PrintMode PrintMode { get; set; }

Property Value

PrintMode

ReportServer

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 https://www.telerik.com/help/reporting/html5-report-viewer-howto-use-it-with-reportserver.html.

Declaration

public ReportServer ReportServer { get; set; }

Property Value

ReportServer

ReportSource

Gets or sets the ReportSource for the report displayed in the viewer.

Declaration

public ReportSource ReportSource { get; set; }

Property Value

ReportSource

Scale

Gets or sets zoom level of the report. 1.0 is equal to 100%, i.e. the original size of the report.

Declaration

public double Scale { get; set; }

Property Value

System.Double

ScaleMode

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.

Declaration

public ScaleMode ScaleMode { get; set; }

Property Value

ScaleMode

SearchMetadataOnDemand

Gets or sets a value indicating whether the search metadata will be delivered on demand or by default.

Declaration

public bool SearchMetadataOnDemand { get; set; }

Property Value

System.Boolean

SendEmail

Gets or sets contains the send e-mail functionality configuration. The enabled property, the preselected rendering Format, from and to e-mail addresses.

Declaration

public SendEmail SendEmail { get; set; }

Property Value

SendEmail

ServiceUrl

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 https://docs.telerik.com/reporting/embedding-reports/host-the-report-engine-remotely/telerik-reporting-rest-services/overview.

Declaration

public string ServiceUrl { get; set; }

Property Value

System.String

TemplateUrl

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 https://www.telerik.com/help/reporting/html5-report-viewer-templates.html.

Declaration

public string TemplateUrl { get; set; }

Property Value

System.String

ViewMode

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.

Declaration

public ViewMode ViewMode { get; set; }

Property Value

ViewMode

Width

Declaration

public override Unit Width { get; set; }

Property Value

System.Web.UI.WebControls.Unit

Methods

GetReportParameters()

Declaration

public IDictionary<string, string> GetReportParameters()

Returns

System.Collections.Generic.IDictionary<System.String, System.String>

LoadViewState(Object)

Declaration

protected override void LoadViewState(object savedState)

Parameters

System.Object savedState

OnInit(EventArgs)

Declaration

protected override void OnInit(EventArgs e)

Parameters

System.EventArgs e

OnPreRender(EventArgs)

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

System.EventArgs e

Render(HtmlTextWriter)

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

System.Web.UI.HtmlTextWriter writer

RenderContents(HtmlTextWriter)

Declaration

protected override void RenderContents(HtmlTextWriter writer)

Parameters

System.Web.UI.HtmlTextWriter writer

RenderDesignTimeHtml(HtmlTextWriter)

Declaration

public void RenderDesignTimeHtml(HtmlTextWriter writer)

Parameters

System.Web.UI.HtmlTextWriter writer

ToString()

Declaration

public override string ToString()

Returns

System.String