Class ReportViewer

Class ReportViewer.

Inheritance
System.Object
CommonDataBoundControl
ReportViewer
Implements
System.Web.UI.IPostBackDataHandler
System.Web.UI.IUrlResolutionService
System.Web.UI.INamingContainer
System.Web.UI.IPostBackEventHandler
Inherited Members
Namespace: Syncfusion.JavaScript.Web
Assembly: Syncfusion.EJ.Web.dll
Syntax
public class ReportViewer : CommonDataBoundControl, IPostBackDataHandler, IUrlResolutionService, INamingContainer, IPostBackEventHandler

Constructors

ReportViewer()

Declaration
public ReportViewer()

Fields

model

Declaration
public ReportViewerProperties model
Field Value
Type Description
ReportViewerProperties

Properties

AutoRender

Gets or sets the autoRender for report viewer.

Declaration
[JsonProperty("autoRender")]
[JsonConverter(typeof(DataManagerConverter))]
public bool AutoRender { get; set; }
Property Value
Type Description
System.Boolean

The AutoRender.

DataSources

Gets or sets the list of data sources for the RDLC report.

Declaration
[JsonProperty("dataSources")]
public List<ReportDataSource> DataSources { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ReportDataSource>

The data sources.

EnableDatasourceBlockScroller

Gets or sets the enableDatasourceBlockScroller for report viewer.

Declaration
[JsonProperty("enableDatasourceBlockScroller")]
[JsonConverter(typeof(DataManagerConverter))]
public bool EnableDatasourceBlockScroller { get; set; }
Property Value
Type Description
System.Boolean

The EnableDatasourceBlockScroller.

EnableDropDownSearch

Gets or sets the the boolean value of enable drop down search Property.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("enableDropDownSearch")]
public bool EnableDropDownSearch { get; set; }
Property Value
Type Description
System.Boolean

The EnableDropDownSearch.

EnableNotificationBar

Gets or sets the the boolean value of enable notification bar Property.

Declaration
[JsonProperty("enableNotificationBar")]
[JsonConverter(typeof(DataManagerConverter))]
public bool EnableNotificationBar { get; set; }
Property Value
Type Description
System.Boolean

The EnableNotificationBar.

EnablePageCache

Gets or sets the the boolean value of enable page cache Property.

Declaration
[JsonProperty("enablePageCache")]
[JsonConverter(typeof(DataManagerConverter))]
public bool EnablePageCache { get; set; }
Property Value
Type Description
System.Boolean

The EnablePageCache.

EnablePageVirtualization

Gets or sets the the boolean value of enable drop down search Property.

Declaration
[JsonProperty("enablePageVirtualization")]
[JsonConverter(typeof(DataManagerConverter))]
public bool EnablePageVirtualization { get; set; }
Property Value
Type Description
System.Boolean

The EnablePageVirtualization.

EnableParameterBlockScroller

Gets or sets the enableParameterBlockScroller for report viewer.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("enableParameterBlockScroller")]
public bool EnableParameterBlockScroller { get; set; }
Property Value
Type Description
System.Boolean

The EnableParameterBlockScroller.

ExportSettings

Specifies the export settings.

Declaration
[JsonProperty("exportSettings")]
[JsonConverter(typeof(DataManagerConverter))]
public ExportSettings ExportSettings { get; set; }
Property Value
Type Description
ExportSettings

The export settings.

IsResponsive

Gets or sets the the boolean value of isResponsive Property when window resized.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("isResponsive")]
public bool IsResponsive { get; set; }
Property Value
Type Description
System.Boolean

The isResponsive.

Locale

Specifies the locale for report viewer.

Declaration
[JsonProperty("locale")]
public string Locale { get; set; }
Property Value
Type Description
System.String

The locale.

Model

Gets or sets the ReportViewer model.

Declaration
public ReportViewerProperties Model { get; set; }
Property Value
Type Description
ReportViewerProperties

The model.

OnClientAjaxBeforeLoad

Fires before the AJAX content is loaded. If you want to perform any operation before AJAX load, you can make use of this ajaxBeforeLoad event.

Declaration
[JsonProperty("ajaxBeforeLoad")]
public string OnClientAjaxBeforeLoad { get; set; }
Property Value
Type Description
System.String

The on client ajax BeforeLoad.

OnClientAjaxError

Fires when ajax request is completes with an error. If you want to perform any operation when ajax request fails, you can make use of the ajaxError event.

Declaration
[JsonProperty("ajaxError")]
public string OnClientAjaxError { get; set; }
Property Value
Type Description
System.String

The ajax error.

OnClientAjaxSuccess

Fires when an ajax request is successfully completed. If you want to perform any operation after the ajax request success, you can make use of the ajaxSuccess event.

Declaration
[JsonProperty("ajaxSuccess")]
public string OnClientAjaxSuccess { get; set; }
Property Value
Type Description
System.String

The ajax success.

OnClientBeforeParameterAdd

Fires when the parameter UI element added before in the paramter block. If you want to add the custom paramter UI element to the parameter block, you can make use of the beforeParameterAdd event.

Declaration
[JsonProperty("beforeParameterAdd")]
public string OnClientBeforeParameterAdd { get; set; }
Property Value
Type Description
System.String

The parameter add before.

OnClientDestroy

Fires when the report viewer is destroyed successfully.If you want to perform any operation after destroying the reportviewer control,you can make use of the destroy event.

Declaration
[JsonProperty("destroy")]
public string OnClientDestroy { get; set; }
Property Value
Type Description
System.String

The on client destroy.

OnClientDrillThrough

Fires during drill through action done in report.If you want to perform any operation when a drill through action is performed, you can make use of the drillThrough event.

Declaration
[JsonProperty("drillThrough")]
public string OnClientDrillThrough { get; set; }
Property Value
Type Description
System.String

The on client drill through.

OnClientExportItemClick

Fires when the Export items is clicked.If you want to perform any operation when a Export items clicked, you can make use of the exportItemClick event.

Declaration
[JsonProperty("exportItemClick")]
public string OnClientExportItemClick { get; set; }
Property Value
Type Description
System.String

The on client exportItem Click.

OnClientExportProgressChanged

Fires when the Export progress is changed.If you want to perform any operation when a Export progress is changed, you can make use of the exportProgressChanged event.

Declaration
[JsonProperty("exportProgressChanged")]
public string OnClientExportProgressChanged { get; set; }
Property Value
Type Description
System.String

The on client exportProgress Changed.

Fires when a user clicks a hyperlink in the report. If you want to do any customization before performing an action that is specified in the report, you can make use of the event.

Declaration
[JsonProperty("hyperlink")]
public string OnClientHyperlink { get; set; }
Property Value
Type Description
System.String

The on client hyperlink.

OnClientParameterUpdateStateChange

Fires when the dependent parameter value is changing in the parameter block. You can add custom user interface, loading indicator and modify the default progress text, using the ParameterUpdateStateChange event.

Declaration
[JsonProperty("parameterUpdateStateChange")]
public string OnClientParameterUpdateStateChange { get; set; }
Property Value
Type Description
System.String

The parameter update state change.

OnClientPrintProgressChanged

Fires when the Print progress changed.If you want to perform any operation when a Print progress is changed, you can make use of the printProgressChanged event.

Declaration
[JsonProperty("printProgressChanged")]
public string OnClientPrintProgressChanged { get; set; }
Property Value
Type Description
System.String

The on client printProgress Changed.

OnClientRenderingBegin

Fires before report rendering is completed.If you want to perform any operation before the rendering of report,you can make use of the renderingBegin event.

Declaration
[JsonProperty("renderingBegin")]
public string OnClientRenderingBegin { get; set; }
Property Value
Type Description
System.String

The on client rendering begin.

OnClientRenderingComplete

Fires after report rendering completed.If you want to perform any operation after the rendering of report,you can make use of this renderingComplete event.

Declaration
[JsonProperty("renderingComplete")]
public string OnClientRenderingComplete { get; set; }
Property Value
Type Description
System.String

The on client rendering complete.

OnClientReportError

Fires when any error occurred while rendering the report.If you want to perform any operation when an error occurs in the report, you can make use of the reportError event.

Declaration
[JsonProperty("reportError")]
public string OnClientReportError { get; set; }
Property Value
Type Description
System.String

The on client report error.

OnClientReportExport

Fires when report is exported.If you want to perform any operation when an error export in the report, you can make use of the reportExport event.

Declaration
[JsonProperty("reportExport")]
public string OnClientReportExport { get; set; }
Property Value
Type Description
System.String

The on client report export.

OnClientReportLoaded

Fires when the report is loaded.If you want to perform any operation after the successful loading of report, you can make use of the reportLoaded event.

Declaration
[JsonProperty("reportLoaded")]
public string OnClientReportLoaded { get; set; }
Property Value
Type Description
System.String

The on client report loaded.

OnClientReportPrint

Fires during report print action done in report.If you want to perform any operation when a report print action is performed, you can make use of the ReportPrint event.

Declaration
[JsonProperty("reportPrint")]
public string OnClientReportPrint { get; set; }
Property Value
Type Description
System.String

The on client report print.

OnClientShowError

Fires when user clicks on a failed report item in the rendered report, before displaying error details dialog. If you want to show custom error detail or perform any action before viewing error detail, you can make use of the showError event.

Declaration
[JsonProperty("showError")]
public string OnClientShowError { get; set; }
Property Value
Type Description
System.String

The on client show error.

OnClientToolBarItemClick

Fires when the Toolbar items is clicked.If you want to perform any operation when a Toolbar items clicked, you can make use of the toolBarItemClick event.

Declaration
[JsonProperty("toolBarItemClick")]
public string OnClientToolBarItemClick { get; set; }
Property Value
Type Description
System.String

The on client toolBarItem Click.

OnClientToolbarRendering

Fires while rendering Report viewer toolbar.If you want to perform any operation while rendering toolbar,you can make use of this toolbarRendering event.

Declaration
[JsonProperty("toolbarRendering")]
public string OnClientToolbarRendering { get; set; }
Property Value
Type Description
System.String

Gets the toolbar rendering event.

OnClientViewReportClick

Fires when click the ViewReport.If you want to modify the current parameter collection while viewReport click, you can make use of the viewReportClick event.

Declaration
[JsonProperty("viewReportClick")]
public string OnClientViewReportClick { get; set; }
Property Value
Type Description
System.String

The on client view Report Click.

PageSettings

Specifies the toolbar settings.

Declaration
[JsonProperty("pageSettings")]
[JsonConverter(typeof(DataManagerConverter))]
public PageSettings PageSettings { get; set; }
Property Value
Type Description
PageSettings

The toolbar settings.

Parameters

Gets or sets the list of parameters associated with the report.

Declaration
[JsonProperty("parameters")]
public List<ReportParameter> Parameters { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ReportParameter>

The parameters.

ParameterSettings

Specifies the parameter settings.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("parameterSettings")]
public ParameterSettings ParameterSettings { get; set; }
Property Value
Type Description
ParameterSettings

The parameter settings.

PrintMode

Gets or sets the the boolean value of print mode Property.

Declaration
[JsonProperty("printMode")]
[JsonConverter(typeof(DataManagerConverter))]
public bool PrintMode { get; set; }
Property Value
Type Description
System.Boolean

The PrintMode.

PrintOption

Specifies the print option.

Declaration
[JsonProperty("printOption")]
[JsonConverter(typeof(StringEnumConverter))]
public PrintOptions PrintOption { get; set; }
Property Value
Type Description
PrintOptions

The PrintOption of Report.

ProcessingMode

Specifies the processing mode of the report.

Declaration
[JsonProperty("processingMode")]
[JsonConverter(typeof(StringEnumConverter))]
public ProcessingMode ProcessingMode { get; set; }
Property Value
Type Description
ProcessingMode

The processing mode.

RenderMode

Specifies the render layout.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("renderMode")]
public RenderMode RenderMode { get; set; }
Property Value
Type Description
RenderMode

The processing mode.

ReportPath

Gets or sets the path of the report file.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("reportPath")]
public string ReportPath { get; set; }
Property Value
Type Description
System.String

The report path.

ReportServerUrl

Gets or sets the reports server URL.

Declaration
[JsonProperty("reportServerUrl")]
public string ReportServerUrl { get; set; }
Property Value
Type Description
System.String

The report server URL.

ReportServiceUrl

Specifies the report Web API service url.

Declaration
[JsonProperty("reportServiceUrl")]
[JsonConverter(typeof(DataManagerConverter))]
public string ReportServiceUrl { get; set; }
Property Value
Type Description
System.String

The report service URL.

ServiceAuthorizationToken

Authenticate the User Token.

Declaration
[JsonProperty("serviceAuthorizationToken")]
[JsonConverter(typeof(DataManagerConverter))]
public string ServiceAuthorizationToken { get; set; }
Property Value
Type Description
System.String

Authorization Token.

ShowExceptionsInDialog

Gets or sets the showExceptionsInDialog for report viewer.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("showExceptionsInDialog")]
public bool ShowExceptionsInDialog { get; set; }
Property Value
Type Description
System.Boolean

The ShowExceptionsInDialog.

SizeToReportContent

Gets or sets the sizeToReportContent for report viewer.

Declaration
[JsonProperty("sizeToReportContent")]
[JsonConverter(typeof(DataManagerConverter))]
public bool SizeToReportContent { get; set; }
Property Value
Type Description
System.Boolean

Render the ReportViewer based on container size.

ToolbarSettings

Specifies the toolbar settings.

Declaration
[JsonProperty("toolbarSettings")]
[JsonConverter(typeof(DataManagerConverter))]
public ToolbarSettings ToolbarSettings { get; set; }
Property Value
Type Description
ToolbarSettings

The toolbar settings.

ZoomFactor

Gets or sets the zoom factor for report viewer.

Declaration
[JsonProperty("zoomFactor")]
public double ZoomFactor { get; set; }
Property Value
Type Description
System.Double

The zoom factor.

Methods

DependentScripts()

Declaration
public List<string> DependentScripts()
Returns
Type Description
System.Collections.Generic.List<System.String>

GetDependentFiles()

Adding dependent scripts.

Declaration
public override List<string> GetDependentFiles()
Returns
Type Description
System.Collections.Generic.List<System.String>

Script files.
Overrides

LoadViewState(Object)

Loads the state of the view state.

Declaration
protected override void LoadViewState(object state)
Parameters
Type Name Description
System.Object state

The state.
Overrides

OnInit(EventArgs)

Declaration
protected override void OnInit(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnLoad(EventArgs)

Declaration
protected override void OnLoad(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

OnPreRender(EventArgs)

Declaration
protected override void OnPreRender(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

RaisePostBackEvent(String)

Declaration
public void RaisePostBackEvent(string EventArgument)
Parameters
Type Name Description
System.String EventArgument

Render()

Renders the instance of ReportViewer.

Declaration
public string Render()
Returns
Type Description
System.String

System.String.

Render(HtmlTextWriter)

Renders the control to the specified HTML writer.

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

The System.Web.UI.HtmlTextWriter object that receives the control content.
Overrides

SaveViewState()

Saves any view-state changes that have occurred since the time the page was posted back to the server.

Declaration
protected override object SaveViewState()
Returns
Type Description
System.Object

The control's current view state. If there is no view state associated with the control, this method returns null.

UpdateServerModel(Dictionary<String, Object>)

Updates the server model.

Declaration
public override void UpdateServerModel(Dictionary<string, object> ClientModel)
Parameters
Type Name Description
System.Collections.Generic.Dictionary<System.String, System.Object> ClientModel

The client model.
Overrides

Implements

System.Web.UI.IPostBackDataHandler
System.Web.UI.IUrlResolutionService
System.Web.UI.INamingContainer
System.Web.UI.IPostBackEventHandler