WPF 6.3.16
Demos Support Blog Download
Show / Hide Table of Contents
PDF

Class ReportViewer

Inheritance
System.Object
ReportViewer
Namespace: BoldReports.UI.Xaml
Assembly: BoldReports.Wpf.dll
Syntax
public class ReportViewer : Control

Constructors

ReportViewer()

Initializes a new instance of the ReportViewer class.

Declaration
public ReportViewer()

Fields

CurrentPageProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty CurrentPageProperty
Field Value
Type Description
System.Windows.DependencyProperty

EnableVirtualEvaluationProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty EnableVirtualEvaluationProperty
Field Value
Type Description
System.Windows.DependencyProperty

ExportOptionsProperty

Identifies the ExportOptions dependency property.

Declaration
public static readonly DependencyProperty ExportOptionsProperty
Field Value
Type Description
System.Windows.DependencyProperty
Remarks

Using a DependencyProperty as the backing store for ExportOptions

ProcessingModeProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ProcessingModeProperty
Field Value
Type Description
System.Windows.DependencyProperty

ReportPathProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ReportPathProperty
Field Value
Type Description
System.Windows.DependencyProperty

ReportServerCredentialProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ReportServerCredentialProperty
Field Value
Type Description
System.Windows.DependencyProperty

ReportServerFormsCredentialProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ReportServerFormsCredentialProperty
Field Value
Type Description
System.Windows.DependencyProperty

ReportServerUrlProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ReportServerUrlProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowContextMenuProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ShowContextMenuProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowExcelExportButtonProperty

Declaration
[Obsolete("This property is obsolete. Use ExportOptionsProperty instead")]
public static readonly DependencyProperty ShowExcelExportButtonProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowExportControlsProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ShowExportControlsProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowHtmlExportButtonProperty

Declaration
[Obsolete("This property is obsolete. Use ExportOptionsProperty instead")]
public static readonly DependencyProperty ShowHtmlExportButtonProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowPageLayoutControlProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ShowPageLayoutControlProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowPageNavigationControlsProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ShowPageNavigationControlsProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowPageSetupButtonProperty

Declaration
public static readonly DependencyProperty ShowPageSetupButtonProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowParameterButtonProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ShowParameterButtonProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowParametersBlockProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ShowParametersBlockProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowPdfExportButtonProperty

Identifies the dependency property.

Declaration
[Obsolete("This property is obsolete. Use ExportOptionsProperty instead")]
public static readonly DependencyProperty ShowPdfExportButtonProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowPPTExportButtonProperty

Declaration
[Obsolete("This property is obsolete. Use ExportOptionsProperty instead")]
public static readonly DependencyProperty ShowPPTExportButtonProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowPrintButtonProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ShowPrintButtonProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowRefreshButtonProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ShowRefreshButtonProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowToolBarProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ShowToolBarProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowWordExportButtonProperty

Declaration
[Obsolete("This property is obsolete. Use ExportOptionsProperty instead")]
public static readonly DependencyProperty ShowWordExportButtonProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowXmlExportButtonProperty

Declaration
[Obsolete("This property is obsolete. Use ExportOptionsProperty instead")]
public static readonly DependencyProperty ShowXmlExportButtonProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowXpsExportButtonProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ShowXpsExportButtonProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowZoomControlProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ShowZoomControlProperty
Field Value
Type Description
System.Windows.DependencyProperty

ViewModeProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ViewModeProperty
Field Value
Type Description
System.Windows.DependencyProperty

ZoomFactorProperty

Identifies the dependency property.

Declaration
public static readonly DependencyProperty ZoomFactorProperty
Field Value
Type Description
System.Windows.DependencyProperty

Properties

Assemblies

Gets the assemblies used in the custom code or code modules.

Declaration
public List<Assembly> Assemblies { get; }
Property Value
Type Description
System.Collections.Generic.List<System.Reflection.Assembly>

A collection that contains the assemblies that are used in the custom code or code modules.

CsvOptions

Gets or sets the CSV device information setting such as encoding, delimiters, qualifiers etc.

Declaration
public CsvOptions CsvOptions { get; set; }
Property Value
Type Description
CsvOptions

CurrentPage

Gets the current page number of the report.

Declaration
public int CurrentPage { get; set; }
Property Value
Type Description
System.Int32

DataSources

Gets the data sources.

Declaration
public ReportDataSourceCollection DataSources { get; }
Property Value
Type Description
BoldReports.Windows.ReportDataSourceCollection

The data source collections.

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.DataSources.Add(new ReportDataSource { Name = "ProductCatalog", Value = ProductCatalog.GetData() });

DisableReportItemPageSplitting

DisableReportItemPageSplitting is to enable or disable the textbox reportitem page splitting to reduce the memory consumption.

Declaration
public bool DisableReportItemPageSplitting { get; set; }
Property Value
Type Description
System.Boolean

EnableVirtualEvaluation

Gets or sets a value indicating whether the zoom button in the toolbar should be visible or not.

Declaration
public bool EnableVirtualEvaluation { get; set; }
Property Value
Type Description
System.Boolean

true To Show the Zoom Button; otherwise, false.

Examples
ReportViewer reportViewer = new ReportViewer();

To Show the Zoom Button

reportViewer.EnableVirtualEvaluation = true;

To Hide the Zoom Button

reportViewer.EnableVirtualEvaluation = false;

ExcelOptions

Gets or Sets the excel writer options.

Declaration
public ExcelOptions ExcelOptions { get; set; }
Property Value
Type Description
ExcelOptions

ExportOptions

Gets or Sets the value for ExportOptions to show/hide exportoptions.

Declaration
public ExportOptions ExportOptions { get; set; }
Property Value
Type Description
BoldReports.UI.Xaml.ExportOptions

The exportoptions to be show/hide.

ExportSettings

Gets or Sets the Export Settings

Declaration
public ExportSettings ExportSettings { get; set; }
Property Value
Type Description
ExportSettings

HTMLOptions

Gets or Sets the HTML writer options.

Declaration
public HTMLOptions HTMLOptions { get; set; }
Property Value
Type Description
HTMLOptions

MeasureTextOption

Gets or sets the MeasureTextOptions.

Declaration
public MeasureTextOptions MeasureTextOption { get; set; }
Property Value
Type Description
MeasureTextOptions

ParameterOptions

Gets or sets the ParameterOptions to customize the report parameter block elements.

Declaration
public ParameterOptions ParameterOptions { get; set; }
Property Value
Type Description
BoldReports.Windows.ParameterOptions

PDFOptions

Gets or Sets the PDF writer options.

Declaration
public PDFOptions PDFOptions { get; set; }
Property Value
Type Description
PDFOptions

PPTOptions

Gets or Sets the PPT writer options.

Declaration
public PPTOptions PPTOptions { get; set; }
Property Value
Type Description
PPTOptions

PrintColorMode

Gets or sets value for Print Color Mode.

Declaration
public PrintColorMode PrintColorMode { get; set; }
Property Value
Type Description
BoldReports.UI.Xaml.PrintColorMode

The print color mode.

Examples
ReportViewer reportViewer = new ReportViewer();

For Color Mode

reportViewer.PrintColorMode = PrintColorMode.Color;

For GrayScale Mode

reportViewer.PrintColorMode = PrintColorMode.GrayScale;

PrintdpiX

Gets or sets value for PrintdpiX.

Declaration
public double PrintdpiX { get; set; }
Property Value
Type Description
System.Double

The PrintdpiX.

PrintdpiY

Gets or sets value for PrintdpiY.

Declaration
public double PrintdpiY { get; set; }
Property Value
Type Description
System.Double

The PrintdpiY.

ProcessingMode

Gets or sets a value for Whether RDLC support or not.

Declaration
public ProcessingMode ProcessingMode { get; set; }
Property Value
Type Description
BoldReports.UI.Xaml.ProcessingMode

Local if this instance is RDLC; otherwise, Remote.

Examples
ReportViewer reportViewer = new ReportViewer();

To Process the RDLC Report

reportViewer.ProcessingMode = ProcessingMode.Local;

To Process the SSRS\RDL Report

reportViewer.ProcessingMode = ProcessingMode.Remote;

ReportPath

Gets or sets RDL(C) report path. This initializes the report viewer.

Declaration
public string ReportPath { get; set; }
Property Value
Type Description
System.String

The report path.

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.ReportPath = @"E:\Samples\WpfRviewerSample\WpfRviewerSample\App_Data\TextboxReport.rdl";

ReportServer

Get or Set the External Report Server Extension.

Declaration
public ReportingServer ReportServer { get; set; }
Property Value
Type Description
ReportingServer

The Report server.

ReportServerCredential

Declaration
public ICredentials ReportServerCredential { get; set; }
Property Value
Type Description
System.Net.ICredentials

ReportServerFormsCredential

Get or Set the Report Server Forms Credential.

Declaration
public ReportServerFormsCredential ReportServerFormsCredential { get; set; }
Property Value
Type Description
ReportServerFormsCredential

The Report server forms Credential.

ReportServerUrl

Get or Set the Report Server Url.

Declaration
public string ReportServerUrl { get; set; }
Property Value
Type Description
System.String

The Report server url.

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.ReportPath = @"/SSRSSamples/Territory Sales";
reportViewer.ReportServerUrl = @"http.://mvc.syncfusion.com/reportserver";

RoundLayoutMeasures

Gets or sets a value for report layout mesuremnt, true if report layout measurement rounding is applied; otherwise, false. The default is true.

Declaration
public bool RoundLayoutMeasures { get; set; }
Property Value
Type Description
System.Boolean

true

ShowContextMenu

Gets or sets a value indicating whether the context menu can be visible or not.

Declaration
public bool ShowContextMenu { get; set; }
Property Value
Type Description
System.Boolean

true To Show the Context Menu; otherwise, false.

Examples
ReportViewer reportViewer = new ReportViewer();

To Show the Context Menu

reportViewer.ShowContextMenu = false;

To Hide the Context Menu

reportViewer.ShowContextMenu = false;

ShowExcelExportButton

Declaration
[Obsolete("This property is obsolete. Use ExportOptions instead")]
public bool ShowExcelExportButton { get; set; }
Property Value
Type Description
System.Boolean

ShowExportControls

Gets or sets a value indicating whether the Export button and related buttons in the toolbar should be visible or not.

Declaration
public bool ShowExportControls { get; set; }
Property Value
Type Description
System.Boolean

True if this toolbar set as visible; otherwise, False.

Examples
ReportViewer reportViewer = new ReportViewer();

To show the Toolbar

reportViewer.ShowExportControls = true;

To Hide the Toolbar

reportViewer.ShowExportControls = false;

ShowHtmlExportButton

Declaration
[Obsolete("This property is obsolete. Use ExportOptions instead")]
public bool ShowHtmlExportButton { get; set; }
Property Value
Type Description
System.Boolean

ShowPageLayoutControl

Gets or sets a value indicating whether the page layout button should be visible or not.

Declaration
public bool ShowPageLayoutControl { get; set; }
Property Value
Type Description
System.Boolean

true To Show the Page Layout Button; otherwise, false.

Examples
ReportViewer reportViewer = new ReportViewer();

To Show the Page Layout Button

reportViewer.ShowPageLayoutControl = true;

To Hide the Page Layout Button

reportViewer.ShowPageLayoutControl = false;

ShowPageNavigationControls

Declaration
public bool ShowPageNavigationControls { get; set; }
Property Value
Type Description
System.Boolean

ShowPageSetupButton

Declaration
public bool ShowPageSetupButton { get; set; }
Property Value
Type Description
System.Boolean

ShowParameterButton

Gets or sets a value indicating whether the print button in the toolbar should be visible or not.

Declaration
public bool ShowParameterButton { get; set; }
Property Value
Type Description
System.Boolean

true To Show the Parameter Button; otherwise, false.

Examples
ReportViewer reportViewer = new ReportViewer();

To Show the Parameter Button

reportViewer.ShowParameterButton = true;

To Hide the Parameter Button

reportViewer.ShowParameterButton = false;

ShowParametersBlock

Gets or sets a value indicating whether the parameter button in the toolbar should be visible or not.

Declaration
public bool ShowParametersBlock { get; set; }
Property Value
Type Description
System.Boolean
Examples
ReportViewer reportViewer = new ReportViewer();

To show the Parameter block

reportViewer.ShowParametersBlock = true;

To Hide the Parameter block

reportViewer.ShowParametersBlock = false;

ShowPdfExportButton

Gets or sets a value indicating whether this instance is export to PDF button collapsed.

Declaration
[Obsolete("This property is obsolete. Use ExportOptions instead")]
public bool ShowPdfExportButton { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is export to PDF button collapsed; otherwise, false.

Examples
ReportViewer reportViewer = new ReportViewer();

To show the Pdf Export Button

reportViewer.ShowPdfExportButton = true;

To Hide the Pdf Export Button

reportViewer.ShowPdfExportButton = false;

ShowPPTExportButton

Declaration
[Obsolete("This property is obsolete. Use ExportOptions instead")]
public bool ShowPPTExportButton { get; set; }
Property Value
Type Description
System.Boolean

ShowPrintButton

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

ShowRefreshButton

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

ShowToolBar

Gets or sets a value indicating whether the toolbar should be visible or not.

Declaration
public bool ShowToolBar { get; set; }
Property Value
Type Description
System.Boolean

true To Show the Tool Bar; otherwise, false.

Examples
ReportViewer reportViewer = new ReportViewer();

To Show the Tool Bar

reportViewer.ShowToolBar = true;

To Hide the Tool Bar

reportViewer.ShowZoomControl = false;

ShowWordExportButton

Declaration
[Obsolete("This property is obsolete. Use ExportOptions instead")]
public bool ShowWordExportButton { get; set; }
Property Value
Type Description
System.Boolean

ShowXmlExportButton

Declaration
[Obsolete("This property is obsolete. Use ExportOptions instead")]
public bool ShowXmlExportButton { get; set; }
Property Value
Type Description
System.Boolean

ShowXpsExportButton

Declaration
public bool ShowXpsExportButton { get; set; }
Property Value
Type Description
System.Boolean

ShowZoomControl

Gets or sets a value indicating whether the zoom button in the toolbar should be visible or not.

Declaration
public bool ShowZoomControl { get; set; }
Property Value
Type Description
System.Boolean

true To Show the Zoom Control; otherwise, false.

Examples
ReportViewer reportViewer = new ReportViewer();

To Show the Zoom Control

reportViewer.ShowZoomControl = true;

To Hide the Zoom Control

reportViewer.ShowZoomControl = false;

ViewMode

Get or Set the Report Render Mode.

Declaration
public ViewMode ViewMode { get; set; }
Property Value
Type Description
BoldReports.UI.Xaml.ViewMode

The Render Mode.

Examples
ReportViewer reportViewer = new ReportViewer();

For Normal Mode

reportViewer.ViewMode = ViewMode.Normal;

For Print Mode

reportViewer.ViewMode = ViewMode.Print;

WordOptions

Gets or Sets the word writer options.

Declaration
public WordOptions WordOptions { get; set; }
Property Value
Type Description
WordOptions

ZoomFactor

Gets or sets a value indicating the Zoom Factor.

Declaration
public double ZoomFactor { get; set; }
Property Value
Type Description
System.Double

The Zoom Factor value.

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.ZoomFactor = 100;

Methods

DisposeReportItemContent(UIElementCollection)

Declaration
public void DisposeReportItemContent(UIElementCollection reportItems)
Parameters
Type Name Description
System.Windows.Controls.UIElementCollection reportItems

Export(Stream, ExportFormat)

Determining the Export option to Export Stream array

Declaration
public void Export(Stream stream, ExportFormat type)
Parameters
Type Name Description
System.IO.Stream stream

Stream of the report

BoldReports.UI.Xaml.ExportFormat type

Export Format Type

ExportAsImage()

Declaration
public List<Image> ExportAsImage()
Returns
Type Description
System.Collections.Generic.List<System.Drawing.Image>

GetDataSetNames()

Get the Data Set Names

Declaration
public IList<string> GetDataSetNames()
Returns
Type Description
System.Collections.Generic.IList<System.String>

Redirect to ReportModel GetDataSetNames if ReportIsRDLCOtherwise Null.

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.GetDataSetNames();

GetDataSources()

Get the Data Source Collections

Declaration
public ReportDataSourceInfoCollection GetDataSources()
Returns
Type Description
BoldReports.Windows.ReportDataSourceInfoCollection

Redirect to ReportModel GetDataSources if ReportIsRDLC and HasReportOtherwise Null.

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.GetDataSources();

GetFixedDocument()

Return FixedDocument

Declaration
public FixedDocument GetFixedDocument()
Returns
Type Description
System.Windows.Documents.FixedDocument

GetImageFromUIElement(StackPanel, Double, Double)

Declaration
public static Image GetImageFromUIElement(StackPanel source, double dpix, double dpiy)
Parameters
Type Name Description
System.Windows.Controls.StackPanel source
System.Double dpix
System.Double dpiy
Returns
Type Description
System.Drawing.Image

GetParameters()

Gets the Parameters Collection.

Declaration
public ReportParameterInfoCollection GetParameters()
Returns
Type Description
BoldReports.Windows.ReportParameterInfoCollection

The collection of paremeters

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.GetParameters();

GetPrintDocument()

Gets the Print Document

Declaration
public PrintDocument GetPrintDocument()
Returns
Type Description
System.Drawing.Printing.PrintDocument

printDocument

Remarks

It will return the print document

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.GetPrintDocument();

GetTotalPage()

Get the Total Page Count

Declaration
public int GetTotalPage()
Returns
Type Description
System.Int32

PageCount if pageModelFactory != nullOtherwise Null.

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.GetTotalPage();

GoTo(Int32)

Move to the specified page number in the report

Declaration
public void GoTo(int pageNo)
Parameters
Type Name Description
System.Int32 pageNo

Page Number Want to Go

LoadReport(Stream)

Loads the Local report for processing

Declaration
public void LoadReport(Stream fileStream)
Parameters
Type Name Description
System.IO.Stream fileStream

File stream as Parameter

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.LoadReport(filestream);

LoadSubreport(String, Stream)

Loads a subreport definition using a Stream.

Declaration
public void LoadSubreport(string reportName, Stream report)
Parameters
Type Name Description
System.String reportName

The path and file name of the subreport definition.

System.IO.Stream report

A Stream class that can be used to read the report definition language (RDL) file for the subreport.

LoadSubreport(String, TextReader)

Loads a subreport definition using a TextReader.

Declaration
public void LoadSubreport(string reportName, TextReader report)
Parameters
Type Name Description
System.String reportName

The path and file name of the subreport definition.

System.IO.TextReader report

A TextReader object that will contain the report definition language (RDL) for the subreport.

LoadSubreport(String, String)

Declaration
public void LoadSubreport(string reportName, string reportPath)
Parameters
Type Name Description
System.String reportName
System.String reportPath

MoveFirst()

Navigates to the First possible page of the current report.

Declaration
public void MoveFirst()

MoveLast()

Navigates to the Last possible page of the current report.

Declaration
public void MoveLast()

MoveNext()

Navigates to the Next page of the current report.

Declaration
public void MoveNext()

MovePrevious()

Navigates to the Previous page of the current report.

Declaration
public void MovePrevious()

OnApplyTemplate()

Declaration
public override void OnApplyTemplate()

OnNavigationButtonsStateChanged(Object, NavigationButtonVisibilityChangedEventArgs)

Called when [navigation buttons state changed].

Declaration
protected virtual void OnNavigationButtonsStateChanged(object sender, NavigationButtonVisibilityChangedEventArgs e)
Parameters
Type Name Description
System.Object sender

The sender.

BoldReports.UI.Xaml.NavigationButtonVisibilityChangedEventArgs e

The instance containing the event data.

OnViewModeChanged(Object, ViewModeChangedEventArgs)

Called when [toggled to normal view].

Declaration
protected virtual void OnViewModeChanged(object sender, ViewModeChangedEventArgs e)
Parameters
Type Name Description
System.Object sender

The sender.

BoldReports.UI.Xaml.ViewModeChangedEventArgs e

The instance containing the event data.

PerformBack()

Declaration
public void PerformBack()

PrintReport()

Processing the Print report option.

Declaration
public void PrintReport()
Remarks

It will display the Print dialog when PrintReport Processing

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.PrintReport();

RaiseDrillThroughEvent(DrillThroughReportModelEventArgs)

Declaration
protected virtual void RaiseDrillThroughEvent(DrillThroughReportModelEventArgs e)
Parameters
Type Name Description
DrillThroughReportModelEventArgs e

RaiseExportCompleted(Byte[])

Declaration
protected virtual void RaiseExportCompleted(byte[] e)
Parameters
Type Name Description
System.Byte[] e

RaiseHyperlinkEvent(HyperlinkEventArgs)

Declaration
protected virtual void RaiseHyperlinkEvent(HyperlinkEventArgs e)
Parameters
Type Name Description
HyperlinkEventArgs e

RaiseRenderingBeginEvent()

Declaration
protected virtual void RaiseRenderingBeginEvent()

RaiseRenderingCompletedEvent()

Declaration
protected virtual void RaiseRenderingCompletedEvent()

RaiseReportErrorEvent(ReportErrorEventArgs)

Declaration
protected virtual void RaiseReportErrorEvent(ReportErrorEventArgs e)
Parameters
Type Name Description
ReportErrorEventArgs e

RaiseReportExport(ReportExportEventArgs)

Declaration
protected virtual void RaiseReportExport(ReportExportEventArgs args)
Parameters
Type Name Description
BoldReports.Windows.ReportExportEventArgs args

RaiseReportLoadedEvent()

Declaration
protected virtual void RaiseReportLoadedEvent()

RaiseReportRefreshCompletedEvent()

Declaration
protected virtual void RaiseReportRefreshCompletedEvent()

RaiseReportRefreshEvent()

Declaration
protected virtual void RaiseReportRefreshEvent()

RaiseSubReportProcessingEvent(SubreportProcessingEventArgs)

Declaration
protected virtual void RaiseSubReportProcessingEvent(SubreportProcessingEventArgs e)
Parameters
Type Name Description
SubreportProcessingEventArgs e

Refresh()

Refresh the report and Navigates to the first possible page and refresh data of the report.

Declaration
public void Refresh()
Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.Refresh();

RefreshReport()

Refresh the Report.

Declaration
public void RefreshReport()
Remarks

Causes the local report to be rendered with new data.

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.RefreshReport();

Reset()

Declaration
public void Reset()

ResetNullableParameters()

Declaration
public void ResetNullableParameters()

SetDataSourceCredentials(DataSourceCredentials[])

Set the Data Source Credentials

Declaration
public void SetDataSourceCredentials(DataSourceCredentials[] dataSourceCredentials)
Parameters
Type Name Description
DataSourceCredentials[] dataSourceCredentials
Remarks

Rediredt to ReportModel SetDataSourceCredentials with dataSourceCredentials parameter

SetDataSourceCredentials(IEnumerable<DataSourceCredentials>)

Declaration
public void SetDataSourceCredentials(IEnumerable<DataSourceCredentials> dataSourceCredentials)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<DataSourceCredentials> dataSourceCredentials

SetParameters(IEnumerable<ReportParameter>)

Sets the Parameters Collection.

Declaration
public void SetParameters(IEnumerable<ReportParameter> reportParameters)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<BoldReports.Windows.ReportParameter> reportParameters

Collection Of Report Parameters

Examples
ReportViewer reportViewer = new ReportViewer();
reportViewer.SetParameters(Params);

ShowPageDialog()

Declaration
public void ShowPageDialog()

Events

DrillThroughReport

Occurs when report drillthrow button clicked.

Declaration
public event DrillThroughReportEventHandler DrillThroughReport
Event Type
Type Description
DrillThroughReportEventHandler

ExportByteCompleted

Occurs when export byte completed.

Declaration
[Obsolete("This event is obsolete. Use ExportCompleted instead.", false)]
public event ExportByteCompletedEventHandler ExportByteCompleted
Event Type
Type Description
ExportByteCompletedEventHandler

ExportCompleted

Occurs when export completed.

Declaration
public event ExportCompletedEventHandler ExportCompleted
Event Type
Type Description
ExportCompletedEventHandler

Hyperlink

Occurs when report hyperlink clicked.

Declaration
public event HyperlinkEventHandler Hyperlink
Event Type
Type Description
HyperlinkEventHandler

Print

Occurs when print report button clicked.

Declaration
public event CancelEventHandler Print
Event Type
Type Description
System.ComponentModel.CancelEventHandler

RenderingBegin

Occurs when report rendering begin.

Declaration
public event RenderingBeginEventHandler RenderingBegin
Event Type
Type Description
RenderingBeginEventHandler

RenderingCompleted

Occurs when report rendering completed.

Declaration
public event RenderingCompletedEventHandler RenderingCompleted
Event Type
Type Description
RenderingCompletedEventHandler

ReportError

Occurs when report error hooked.

Declaration
public event ReportErrorHandler ReportError
Event Type
Type Description
ReportErrorHandler

ReportExport

Occurs when the user clicks the Export button.

Declaration
public event ExportEventHandler ReportExport
Event Type
Type Description
ExportEventHandler

ReportLoaded

Occurs when report loaded for ReportViewer.

Declaration
public event ReportLoadedEventHandler ReportLoaded
Event Type
Type Description
ReportLoadedEventHandler

ReportRefresh

Occurs when report refresh button clicked.

Declaration
public event RefreshEventHandler ReportRefresh
Event Type
Type Description
RefreshEventHandler

ReportRefreshCompleted

Occurs when report refresh completed.

Declaration
public event RefreshEventHandler ReportRefreshCompleted
Event Type
Type Description
RefreshEventHandler

SubreportProcessing

Occurs when processing the subreport.

Declaration
public event SubreportProcessingEventHandler SubreportProcessing
Event Type
Type Description
SubreportProcessingEventHandler

ViewButtonClick

Occurs when view report button clicked.

Declaration
[CLSCompliant(false)]
public event CancelEventHandler ViewButtonClick
Event Type
Type Description
System.ComponentModel.CancelEventHandler

ViewModeChanged

Occurs when toggled to normal view.

Declaration
public event ViewModeChangedEventHandler ViewModeChanged
Event Type
Type Description
BoldReports.UI.Xaml.ViewModeChangedEventHandler
In This Article
Was this page helpful? Yes No
Thank you for your feedback!
Thank you for your feedback and comments. We will rectify this as soon as possible!
An unknown error has occurred. Please try again.
×
SEND FEEDBACK REGARDING THIS TOPIC

Please provide additional information

Please provide additional information

Please provide additional information

Please provide additional information
Please provide additional information
Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved