Class ReportViewerPropertiesBuilder

Class for ReportViewerPropertiesBuilder.

Inheritance

System.Object

ReportViewerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class ReportViewerPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

ReportViewerPropertiesBuilder()

Declaration

public ReportViewerPropertiesBuilder()

ReportViewerPropertiesBuilder(ReportViewer)

Initializes a new instance of the ReportViewerPropertiesBuilder class.

Declaration

public ReportViewerPropertiesBuilder(ReportViewer reportViewer)

Parameters

Type	Name	Description
ReportViewer	reportViewer	The report viewer.

Methods

AjaxBeforeLoad(String)

Fires when ajax call is initiated.If you want to perform any operation when ajax initiated,you can make use of the ajaxBeforeLoad event.

Declaration

public ReportViewerPropertiesBuilder AjaxBeforeLoad(string ajaxBeforeLoad)

Parameters

Type	Name	Description
System.String	ajaxBeforeLoad	The ajax before load.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

AjaxError(String)

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

public ReportViewerPropertiesBuilder AjaxError(string ajaxError)

Parameters

Type	Name	Description
System.String	ajaxError	The ajax error.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

AjaxSuccess(String)

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

public ReportViewerPropertiesBuilder AjaxSuccess(string ajaxSuccess)

Parameters

Type	Name	Description
System.String	ajaxSuccess	The ajax success.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

AutoRender(Boolean)

Gets or sets the autoRender of the report.

Declaration

public ReportViewerPropertiesBuilder AutoRender(bool autoRender)

Parameters

Type	Name	Description
System.Boolean	autoRender	To disable or enable the parameter block scroller.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

BeforeParameterAdd(String)

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

public ReportViewerPropertiesBuilder BeforeParameterAdd(string beforeParameterAdd)

Parameters

Type	Name	Description
System.String	beforeParameterAdd	The parameter add before.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

DataSources(Action<ReportDataSourceBuilder>)

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

Declaration

public ReportViewerPropertiesBuilder DataSources(Action<ReportDataSourceBuilder> datasources)

Parameters

Type	Name	Description
System.Action<ReportDataSourceBuilder>	datasources	The datasources.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

DataSources(List<ReportDataSource>)

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

Declaration

public ReportViewerPropertiesBuilder DataSources(List<ReportDataSource> datasources)

Parameters

Type	Name	Description
System.Collections.Generic.List<ReportDataSource>	datasources	The list of datasources.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

DrillThrough(String)

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

public ReportViewerPropertiesBuilder DrillThrough(string drillThrough)

Parameters

Type	Name	Description
System.String	drillThrough	The drill through.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

EnableDatasourceBlockScroller(Boolean)

Gets or sets the enableDatasourceBlockScroller of the report.

Declaration

public ReportViewerPropertiesBuilder EnableDatasourceBlockScroller(bool enableDatasourceBlockScroller)

Parameters

Type	Name	Description
System.Boolean	enableDatasourceBlockScroller	To disable or enable the datasource block scroller.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

EnableDropDownSearch(Boolean)

Gets or sets the enable Drop Down Search of the report.

Declaration

public ReportViewerPropertiesBuilder EnableDropDownSearch(bool enableDropDownSearch)

Parameters

Type	Name	Description
System.Boolean	enableDropDownSearch	The enable Drop Down Search.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

EnableNotificationBar(Boolean)

Gets or sets the enable Notification Bar of the report.

Declaration

public ReportViewerPropertiesBuilder EnableNotificationBar(bool enableNotificationBar)

Parameters

Type	Name	Description
System.Boolean	enableNotificationBar	The enable Notification Bar.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

EnablePageCache(Boolean)

Gets or sets the enable page cache of the report.

Declaration

public ReportViewerPropertiesBuilder EnablePageCache(bool enablePageCache)

Parameters

Type	Name	Description
System.Boolean	enablePageCache	The enable page cache.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

EnablePageVirtualization(Boolean)

Gets or sets the enable page virtualization of the report.

Declaration

public ReportViewerPropertiesBuilder EnablePageVirtualization(bool enablePageVirtualization)

Parameters

Type	Name	Description
System.Boolean	enablePageVirtualization	The enable page virtualization.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

EnableParameterBlockScroller(Boolean)

Gets or sets the enableParameterBlockScroller of the report.

Declaration

public ReportViewerPropertiesBuilder EnableParameterBlockScroller(bool enableParameterBlockScroller)

Parameters

Type	Name	Description
System.Boolean	enableParameterBlockScroller	To disable or enable the parameter block scroller.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ExportItemClick(String)

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

public ReportViewerPropertiesBuilder ExportItemClick(string exportItemClick)

Parameters

Type	Name	Description
System.String	exportItemClick	The exportItem Click.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ExportProgressChanged(String)

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

public ReportViewerPropertiesBuilder ExportProgressChanged(string exportProgressChanged)

Parameters

Type	Name	Description
System.String	exportProgressChanged	The exportProgress Changed.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ExportSettings(Action<ExportSettingsBuilder>)

Specifies the export settings.

Declaration

public ReportViewerPropertiesBuilder ExportSettings(Action<ExportSettingsBuilder> exportSettings)

Parameters

Type	Name	Description
System.Action<ExportSettingsBuilder>	exportSettings	The export settings.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

Hyperlink(String)

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

public ReportViewerPropertiesBuilder Hyperlink(string hyperlink)

Parameters

Type	Name	Description
System.String	hyperlink	The hyperlink.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

IsResponsive(Boolean)

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

Declaration

public ReportViewerPropertiesBuilder IsResponsive(bool isResponsive)

Parameters

Type	Name	Description
System.Boolean	isResponsive	The isResponsive.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

Locale(String)

Specifies the locale for report viewer.

Declaration

public ReportViewerPropertiesBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale	The locale.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

PageSettings(Action<PageSettingsBuilder>)

Specifies the page settings.

Declaration

public ReportViewerPropertiesBuilder PageSettings(Action<PageSettingsBuilder> pageSettings)

Parameters

Type	Name	Description
System.Action<PageSettingsBuilder>	pageSettings	The page settings.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

Parameters(Action<ReportParameterBuilder>)

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

Declaration

public ReportViewerPropertiesBuilder Parameters(Action<ReportParameterBuilder> parameters)

Parameters

Type	Name	Description
System.Action<ReportParameterBuilder>	parameters	The parameters.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

Parameters(List<ReportParameter>)

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

Declaration

public ReportViewerPropertiesBuilder Parameters(List<ReportParameter> parameters)

Parameters

Type	Name	Description
System.Collections.Generic.List<ReportParameter>	parameters	The list of parameters.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ParameterSettings(ParameterSettings)

Specifies the parameter settings.

Declaration

public ReportViewerPropertiesBuilder ParameterSettings(ParameterSettings parameterSettings)

Parameters

Type	Name	Description
ParameterSettings	parameterSettings	The parameter settings.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ParameterSettings(Action<ParameterSettingsBuilder>)

Specifies the parameter settings.

Declaration

public ReportViewerPropertiesBuilder ParameterSettings(Action<ParameterSettingsBuilder> parameterSettings)

Parameters

Type	Name	Description
System.Action<ParameterSettingsBuilder>	parameterSettings	The parameter settings.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ParameterUpdateStateChange(String)

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

public ReportViewerPropertiesBuilder ParameterUpdateStateChange(string parameterUpdateStateChange)

Parameters

Type	Name	Description
System.String	parameterUpdateStateChange	The View Report Click.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

PrintMode(Boolean)

Gets or sets the print mode for the report.

Declaration

public ReportViewerPropertiesBuilder PrintMode(bool printMode)

Parameters

Type	Name	Description
System.Boolean	printMode	The specifies the print mode.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

PrintOption(PrintOptions)

Specifies the print option of the reportviewer container based on device type.

Declaration

public ReportViewerPropertiesBuilder PrintOption(PrintOptions printOption)

Parameters

Type	Name	Description
PrintOptions	printOption	The PrintOptions of Report.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

PrintProgressChanged(String)

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

public ReportViewerPropertiesBuilder PrintProgressChanged(string printProgressChanged)

Parameters

Type	Name	Description
System.String	printProgressChanged	The printProgress Changed.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ProcessingMode(ProcessingMode)

Specifies the processing mode of the report.

Declaration

public ReportViewerPropertiesBuilder ProcessingMode(ProcessingMode processingMode)

Parameters

Type	Name	Description
ProcessingMode	processingMode	The processing mode.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

Render()

Renders the reportviewer instance.

Declaration

public void Render()

RenderingBegin(String)

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

public ReportViewerPropertiesBuilder RenderingBegin(string renderingBegin)

Parameters

Type	Name	Description
System.String	renderingBegin	The rendering begin.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

RenderingComplete(String)

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

public ReportViewerPropertiesBuilder RenderingComplete(string renderingComplete)

Parameters

Type	Name	Description
System.String	renderingComplete	The rendering complete.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

RenderMode(RenderMode)

Specifies the render mode of the reportviewer container based on device type.

Declaration

public ReportViewerPropertiesBuilder RenderMode(RenderMode renderMode)

Parameters

Type	Name	Description
RenderMode	renderMode	The render mode.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ReportError(String)

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

public ReportViewerPropertiesBuilder ReportError(string reportError)

Parameters

Type	Name	Description
System.String	reportError	The report error.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ReportExport(String)

Fires while click the Report Export type.If you want to perform any operation when a report Export action is performed, you can make use of the reportExport event.

Declaration

public ReportViewerPropertiesBuilder ReportExport(string reportExport)

Parameters

Type	Name	Description
System.String	reportExport	The report export.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ReportLoaded(String)

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

public ReportViewerPropertiesBuilder ReportLoaded(string reportLoaded)

Parameters

Type	Name	Description
System.String	reportLoaded	The report loaded.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ReportPath(String)

Gets or sets the path of the report file.

Declaration

public ReportViewerPropertiesBuilder ReportPath(string reportPath)

Parameters

Type	Name	Description
System.String	reportPath	The report path.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ReportPrint(String)

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

public ReportViewerPropertiesBuilder ReportPrint(string reportPrint)

Parameters

Type	Name	Description
System.String	reportPrint	The report print.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ReportServerUrl(String)

Gets or sets the reports server url.

Declaration

public ReportViewerPropertiesBuilder ReportServerUrl(string reportServerUrl)

Parameters

Type	Name	Description
System.String	reportServerUrl	The report server URL.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ReportServiceUrl(String)

Specifies the report Web API service url.

Declaration

public ReportViewerPropertiesBuilder ReportServiceUrl(string reportServiceUrl)

Parameters

Type	Name	Description
System.String	reportServiceUrl	The report service URL.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ServiceAuthorizationToken(String)

Authenticate the User Token.

Declaration

public ReportViewerPropertiesBuilder ServiceAuthorizationToken(string serviceAuthorizationToken)

Parameters

Type	Name	Description
System.String	serviceAuthorizationToken	Authorization Token.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ShowError(String)

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

public ReportViewerPropertiesBuilder ShowError(string showError)

Parameters

Type	Name	Description
System.String	showError	The show error.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ShowExceptionsInDialog(Boolean)

Gets or sets the showExceptionsInDialog for report viewer.

Declaration

public ReportViewerPropertiesBuilder ShowExceptionsInDialog(bool showExceptionsInDialog)

Parameters

Type	Name	Description
System.Boolean	showExceptionsInDialog	The show exceptions in dialog.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

SizeToReportContent(Boolean)

Gets or sets the sizeToReportContent of the report.

Declaration

public ReportViewerPropertiesBuilder SizeToReportContent(bool sizeToReportContent)

Parameters

Type	Name	Description
System.Boolean	sizeToReportContent	Render the ReportViewer height based on container size.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ToHtmlString()

Returns an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String	An HTML-encoded string.

ToolBarItemClick(String)

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

public ReportViewerPropertiesBuilder ToolBarItemClick(string toolBarItemClick)

Parameters

Type	Name	Description
System.String	toolBarItemClick	The toolBarItem Click.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ToolbarRendering(String)

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

Declaration

public ReportViewerPropertiesBuilder ToolbarRendering(string toolbarRendering)

Parameters

Type	Name	Description
System.String	toolbarRendering	Gets the toolbar rendering event.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ToolbarSettings(Action<ToolbarSettingsBuilder>)

Specifies the toolbar settings.

Declaration

public ReportViewerPropertiesBuilder ToolbarSettings(Action<ToolbarSettingsBuilder> toolbarSettings)

Parameters

Type	Name	Description
System.Action<ToolbarSettingsBuilder>	toolbarSettings	The toolbar settings.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ViewReportClick(String)

Fires when the View Report is clicked.

Declaration

public ReportViewerPropertiesBuilder ViewReportClick(string viewReportClick)

Parameters

Type	Name	Description
System.String	viewReportClick	The View Report Click.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

ZoomFactor(String)

Gets or sets the zoom factor for report viewer.

Declaration

public ReportViewerPropertiesBuilder ZoomFactor(string zoomFactor)

Parameters

Type	Name	Description
System.String	zoomFactor	The zoom factor.

Returns

Type	Description
ReportViewerPropertiesBuilder	ReportViewerPropertiesBuilder.

Implements

IPropertiesBuilder

System.Web.IHtmlString