Class ReportViewer

Inheritance
System.Object
ReportViewer
Namespace: Telerik.ReportViewer.WebForms
Assembly: Telerik.ReportViewer.WebForms.dll

Syntax

public class ReportViewer : CompositeControl, IParserAccessor

Constructors

ReportViewer()

Declaration
public ReportViewer()

Properties

DocumentMapVisible

Indicates whether the DocumentMap should be visible.

Declaration
public bool DocumentMapVisible { get; set; }
Property Value
System.Boolean

Height

Declaration
public override Unit Height { get; set; }
Property Value
System.Web.UI.WebControls.Unit

ParametersAreaVisible

Indicates whether the ParametersArea should be visible.

Declaration
public bool ParametersAreaVisible { get; set; }
Property Value
System.Boolean

ProgressText

Declaration
[Obsolete("Use Resources.ProcessingReportMessage property instead or the resource file.")]
public string ProgressText { get; set; }
Property Value
System.String

Report

Gets or sets the report displayed in the viewer.

Declaration
[Obsolete("Telerik.ReportViewer.WebForms.ReportViewer.Report property is now obsolete. Please use the Telerik.ReportViewer.WebForms.ReportViewer.ReportSource property instead. For more information, please visit: http://www.telerik.com/support/kb/reporting/general/q2-2012-api-changes-reportsources.aspx#aspnetviewer.")]
public IReportDocument Report { get; set; }
Property Value
IReportDocument

ReportBookID

Declaration
public string ReportBookID { get; set; }
Property Value
System.String

ReportSource

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

Declaration
public ReportSource ReportSource { get; set; }
Property Value
ReportSource

See Also

Resources

Use to customize the texts for labels, tooltips and messages.

Declaration
public Resources Resources { get; }
Property Value
Resources

ShowDocumentMapButton

Indicates whether DocumentMap button should be visible.

Declaration
public bool ShowDocumentMapButton { get; set; }
Property Value
System.Boolean

ShowExportGroup

Indicates whether Export group should be visible.

Declaration
public bool ShowExportGroup { get; set; }
Property Value
System.Boolean

ShowHistoryButtons

Indicates whether the page navigation controls are visible.

Declaration
public bool ShowHistoryButtons { get; set; }
Property Value
System.Boolean

ShowNavigationGroup

Indicates whether the page navigation controls are visible.

Declaration
public bool ShowNavigationGroup { get; set; }
Property Value
System.Boolean

ShowParametersButton

Indicates whether Parameters button should be visible.

Declaration
public bool ShowParametersButton { get; set; }
Property Value
System.Boolean

ShowPrintButton

Indicates whether Print button should be visible.

Declaration
public bool ShowPrintButton { get; set; }
Property Value
System.Boolean

ShowPrintPreviewButton

Indicates whether PrintPreview button should be visible.

Declaration
public bool ShowPrintPreviewButton { get; set; }
Property Value
System.Boolean

ShowRefreshButton

Indicates whether the Refresh button should be visible.

Declaration
public bool ShowRefreshButton { get; set; }
Property Value
System.Boolean

ShowZoomSelect

Indicates whether the Zoom input box should be visible.

Declaration
[Obsolete("ZoomMode/ZoomPercent is obsolete and should not be used anymore.")]
public bool ShowZoomSelect { get; set; }
Property Value
System.Boolean

Skin

Gets or sets the name of the skin that is used by the viewer.

Declaration
public string Skin { get; set; }
Property Value
System.String

A string containing the name of the currently used skin. The default value is Default.

SkinsPath

Gets or sets the relative path of the folder containing the skins.

Declaration
public virtual string SkinsPath { get; set; }
Property Value
System.String

A string specifying the relative path to the folder which contains ReportViewer skins. The default value is "~/ReportViewer/Skins".

TagKey

Declaration
protected override HtmlTextWriterTag TagKey { get; }
Property Value
System.Web.UI.HtmlTextWriterTag

ToolbarVisible

Indicates whether the toolbar should be visible on the viewer.

Declaration
public bool ToolbarVisible { get; set; }
Property Value
System.Boolean

ViewMode

Specifies whether the viewer is in interactive or print preview mode.

Declaration
public ViewMode ViewMode { get; set; }
Property Value
ViewMode

Width

Declaration
public override Unit Width { get; set; }
Property Value
System.Web.UI.WebControls.Unit

ZoomMode

Gets or sets the zoom mode of the viewer.

Declaration
[Obsolete("ZoomMode/ZoomPercent is obsolete and should not be used anymore.")]
public ZoomMode ZoomMode { get; set; }
Property Value
ZoomMode

ZoomPercent

Gets or sets the percentage of zoom used for the report display.

Declaration
[Obsolete("ZoomMode/ZoomPercent is obsolete and should not be used anymore.")]
public int ZoomPercent { get; set; }
Property Value
System.Int32

Methods

CreateChildControls()

Declaration
protected override void CreateChildControls()

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

OnLoad(EventArgs)

Declaration
protected override void OnLoad(EventArgs e)
Parameters
System.EventArgs e

OnPreRender(EventArgs)

Declaration
protected override void OnPreRender(EventArgs e)
Parameters
System.EventArgs e

RecreateChildControls()

Declaration
protected override void RecreateChildControls()

RefreshData()

Refreshes the current report in the viewer. Last used parameter values are used.

Declaration
public void RefreshData()

RefreshReport()

Causes the viewer to clear the cache and render the report again.

Declaration
public void RefreshReport()

Render(HtmlTextWriter)

Declaration
protected override void Render(HtmlTextWriter writer)
Parameters
System.Web.UI.HtmlTextWriter writer

SaveViewState()

Declaration
protected override object SaveViewState()
Returns
System.Object