New to Telerik Reporting? Start a free 30-day trial

Provides the base functionality for a report viewer.

Definition

Namespace:Telerik.ReportViewer.WinForms

Assembly:Telerik.ReportViewer.WinForms.dll

Syntax:

C#
[Docking(DockingBehavior.AutoDock)]
public abstract class ReportViewerBase : UserControl

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlContainerControlUserControlReportViewerBase...

Derived Classes: ReportViewer

Properties

Gets or sets the accessibility key shortcuts map, used when the report viewer is in accessible mode. Returns null reference if the viewer's accessibility is not enabled.

C#
[Browsable(false)]
public Dictionary<int, ShortcutKeys> AccessibilityKeyMap { get; set; }

Gets or sets a value that determines whether the execution of NavigateToURL action that points to a file is allowed. If set to false, navigating to local or network file from NavigateToUrl action will be disabled. If set to true, navigating to local or network file from NavigateToUrl action will show a confirmation window before executing the action. Default value: false

C#
public bool AllowNavigatingToFileUrls { get; set; }

Gets or sets the current page in the viewer.

C#
[Browsable(false)]
public int CurrentPage { get; set; }
Example:
cs-api-definition
// Navigate to a desired page
private void button2_Click(object sender, System.EventArgs e)
{
var desiredPage = 5;

// Check if the viewer can navigate to the page since the report may have fewer pages for example
if (this.reportViewer1.CanMoveToPage(desiredPage))
{
// By setting the property the viewer will automatically navigate to the page in question
this.reportViewer1.CurrentPage = desiredPage;
}
}

Gets or sets a value that indicates whether the document map is displayed if any bookmark is defined.

C#
public bool DocumentMapVisible { get; set; }
Example:
cs-api-definition
' Toggle the document map
Private Sub button9_Click(sender As Object, e As System.EventArgs)
Me.ReportViewer1.DocumentMapVisible = Not Me.ReportViewer1.DocumentMapVisible
End Sub

Gets or sets a value that indicates whether the accessibility features of the report viewer and its contents should be enabled.

C#
public bool EnableAccessibility { get; set; }

Default value: false

Determines if navigate back in report viewer history operation is enabled

C#
[Browsable(false)]
public bool NavigateBackEnabled { get; }
Example:
cs-api-definition
// Navigate to the previous report in the history if available
private void button7_Click(object sender, System.EventArgs e)
{
if (this.reportViewer1.NavigateBackEnabled)
{
this.reportViewer1.NavigateBack();
}
}

Determines if navigate forward in report viewer history operation is enabled

C#
[Browsable(false)]
public bool NavigateForwardEnabled { get; }
Example:
cs-api-definition
// Navigate to the next report in the history if available
private void button8_Click(object sender, System.EventArgs e)
{
if (this.reportViewer1.NavigateBackEnabled)
{
this.reportViewer1.NavigateBack();
}
}

Gets or sets a value that indicates whether the parameters area is displayed if any parameter editor exists.

C#
public bool ParametersAreaVisible { get; set; }
Example:
cs-api-definition
' Toggle the parameters area
Private Sub button10_Click(sender As Object, e As System.EventArgs)
Me.ReportViewer1.ParametersAreaVisible = Not Me.ReportViewer1.ParametersAreaVisible
End Sub

Gets the current processing state of the viewer

C#
[Browsable(false)]
public ProcessingState ProcessingState { get; }

Gets the available rendering extensions list.

C#
[Browsable(false)]
public IEnumerable<RenderingExtension> RenderingExtensions { get; }

Gets or sets the report displayed in the viewer.

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

The connection string used to configure the reporting engine that will process and render the reports.

C#
public string ReportEngineConnection { get; set; }

If the selected engine is of remote type (REST Service or Report Server), the following extra dependencies are required:

  • Telerik.Reporting.Services.HttpClient
  • System.Net.Http
  • System.Net.Http.Formatting

Note: Connecting to Report Server for .NET is not supported yet.

Example:
cs-api-definition
private void SetEmbeddedReportEngineConnection(object sender, System.EventArgs e)
{
this.reportViewer1.ReportEngineConnection = new Telerik.ReportViewer.Common.EmbeddedConnectionInfo().ConnectionString;
//if the ReportEngineConnection property is set to null or empty string, it will use the EmbeddedConnectionInfo by default.
}

Gets or sets the ReportSource for the report displayed in the viewer. Set this property in order to change the report shown in the viewer. The RefreshReport() method must be called in order to invoke the actual report change in the viewer.

C#
public ReportSource ReportSource { get; set; }

Gets the ReportViewerModel instance.

C#
public IReportViewerModel ReportViewerModel { get; }

Gets the localized resources used by the report viewer.

C#
[TypeConverter(typeof(ExpandableObjectConverter))]
public Resources Resources { get; }

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

C#
public bool SearchMetadataOnDemand { get; set; }

Enabling search will notify the report engine to produce search metadata while rendering the report. This metadata is used by the report viewer in search dialog and in the report viewer area for highlighting the found and selected items. Default value: false

Indicates whether DocumentMap button should be visible.

C#
public bool ShowDocumentMapButton { get; set; }

Indicates whether Export button should be visible.

C#
public bool ShowExportButton { get; set; }

Indicates whether the history (Back, Forward) buttons should be visible.

C#
public bool ShowHistoryButtons { get; set; }

Indicates whether the page navigation controls are visible.

C#
public bool ShowPageNavigationControls { get; set; }

Indicates whether PageSetup button should be visible.

C#
[Obsolete("Use ReportViewerBase.ShowPageSetupButton property instead.")]
[Browsable(false)]
public bool ShowPageSetup { get; set; }

Indicates whether PageSetup button should be visible.

C#
public bool ShowPageSetupButton { get; set; }

Indicates whether Parameters button should be visible.

C#
public bool ShowParametersButton { get; set; }

Indicates whether Print button should be visible.

C#
public bool ShowPrintButton { get; set; }

Indicates whether PrintPreview button should be visible.

C#
public bool ShowPrintPreviewButton { get; set; }

Indicates whether progress animation should be displayed while the report is rendered.

C#
public bool ShowProgress { get; set; }

Indicates whether the Refresh button should be visible.

C#
public bool ShowRefreshButton { get; set; }

Indicates whether Search button should be visible.

C#
public bool ShowSearchButton { get; set; }

If the button is visible, it will set the viewer's EnableSearch property to true, when pressed.

Indicates whether the Stop button should be visible.

C#
public bool ShowStopButton { get; set; }

Indicates whether the Zoom input box should be visible.

C#
public bool ShowZoom { get; set; }

Indicates whether the toolbar should be visible on the viewer.

C#
public bool ToolbarVisible { get; set; }

Gets the count of the available pages in the viewer.

C#
[Browsable(false)]
public int TotalPages { get; }
Example:
cs-api-definition
' Go to the middle of the report
Private Sub button11_Click(sender As Object, e As System.EventArgs)
Dim middlePage = Me.ReportViewer1.TotalPages / 2
Me.ReportViewer1.CurrentPage = middlePage
End Sub

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

C#
public ViewMode ViewMode { get; set; }
Example:
cs-api-definition
' Switch to interactive mode
Private Sub button12_Click(sender As Object, e As System.EventArgs)
Me.ReportViewer1.ViewMode = Telerik.ReportViewer.WinForms.ViewMode.Interactive
End Sub

Gets or sets the zoom mode of the viewer.

C#
public ZoomMode ZoomMode { get; set; }
Example:
cs-api-definition
' Set the zoom mode to PageWidth
Private Sub button14_Click(sender As Object, e As System.EventArgs)
Me.ReportViewer1.ZoomMode = Telerik.ReportViewer.WinForms.ZoomMode.PageWidth
End Sub

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

C#
public int ZoomPercent { get; set; }
Example:
cs-api-definition
' Set the zoom percent to a specific value
Private Sub button13_Click(sender As Object, e As System.EventArgs)
Me.ReportViewer1.ZoomMode = Telerik.ReportViewer.WinForms.ZoomMode.Percent
Me.ReportViewer1.ZoomPercent = 140
End Sub

Methods

Adds viewer-specific values to the rendering context.

C#
protected virtual void AddToRenderingContext(IDictionary renderingContext)
Parameters:renderingContextIDictionary

Stops the background processing of the report.

C#
public void CancelRendering()
Example:
cs-api-definition
// Stop rendering the report.
private void button1_Click(object sender, System.EventArgs e)
{
this.reportViewer1.CancelRendering();
}

Stops background processing of the report.

C#
[Obsolete("CancelRendering(int timeout) method is now obsolete. Please use the Telerik.ReportViewer.WinForms.ReportViewer.CancelRendering() method instead.")]
public bool CancelRendering(int timeout)
Parameters:timeoutint

The number of milliseconds to wait for the background rendering to terminate. A value of -1 waits forever. A value of 0 returns immediately without waiting for the rendering to terminate.

Returns:

bool

A Boolean value. A value of true is returned if the background rendering has terminated. A value of false is returned if background rendering has not terminated after the amount of time specified in the millisecondsTimeout parameter has elapsed, or if the millisecondsTimeout parameter was set to 0.

Determines whether the viewer can be navigated to a specified page.

C#
public bool CanMoveToPage(int pageIndex)
Parameters:pageIndexint

The page number to determine navigation possibility.

Returns:

bool

Returns true if the viewer can be moved to the specified page.

Example:
cs-api-definition
// Navigate to a desired page
private void button2_Click(object sender, System.EventArgs e)
{
var desiredPage = 5;

// Check if the viewer can navigate to the page since the report may have fewer pages for example
if (this.reportViewer1.CanMoveToPage(desiredPage))
{
// By setting the property the viewer will automatically navigate to the page in question
this.reportViewer1.CurrentPage = desiredPage;
}
}

Clears the report viewer navigation history.

C#
public void ClearHistory()

Use this method to remove all viewer history records generated:

All history records including for the currently shown ReportSource are deleted.

Releases the resources used by this object.

C#
protected override void Dispose(bool disposing)
Parameters:disposingbool

Overrides: ContainerControl.Dispose(bool)

Exports the report in the specified format.

C#
public void ExportReport(string format, Hashtable deviceInfo)
Parameters:formatstring

Export format

deviceInfoHashtable

Contains parameters to pass to the rendering extension.

Example:
cs-api-definition
// Opens the dialog to export the report
private void button5_Click(object sender, System.EventArgs e)
{
this.reportViewer1.ExportReport("PDF", null);
}

Formats the file navigation confirmation message.

C#
protected string FormatNavigateToFileConfirmation(string url)
Parameters:urlstringReturns:

string

virtual for test purposes only.

C#
protected virtual void HandleNavigateToFileActionNotSupported(NotSupportedException nsx)
Parameters:nsxNotSupportedException

Navigates the viewer back one step in the navigation history.

C#
public void NavigateBack()

Check NavigateBackEnabled if this operation is enabled. If not, exception is thrown.
The ReportSource property will reflect the change in the currently shown report.

Example:
cs-api-definition
// Navigate to the previous report in the history if available
private void button7_Click(object sender, System.EventArgs e)
{
if (this.reportViewer1.NavigateBackEnabled)
{
this.reportViewer1.NavigateBack();
}
}

Navigates the viewer forward one step in the navigation history.

C#
public void NavigateForward()

Check NavigateForwardEnabled if this operation is enabled. If not, exception is thrown.
The ReportSource property will reflect the change in the currently shown report.

Example:
cs-api-definition
// Navigate to the next report in the history if available
private void button8_Click(object sender, System.EventArgs e)
{
if (this.reportViewer1.NavigateBackEnabled)
{
this.reportViewer1.NavigateBack();
}
}

Raises the Error event.

C#
protected virtual void OnError(ErrorEventArgs e)
Parameters:eErrorEventArgs

The ErrorEventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Raises the ExportBegin event.

C#
protected virtual void OnExportBegin(ExportBeginEventArgs e)
Parameters:eExportBeginEventArgs

The ExportBeginEventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Raises the ExportEnd event.

C#
protected virtual void OnExportEnd(ExportEndEventArgs e)
Parameters:eExportEndEventArgs

The ExportEndEventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Raises the InteractiveActionEnter event.

C#
protected virtual void OnInteractiveActionEnter(InteractiveActionEventArgs e)
Parameters:eInteractiveActionEventArgs

The InteractiveActionEventArgs that contains the event data.

Raises the InteractiveActionExecuting event.

C#
protected virtual void OnInteractiveActionExecuting(InteractiveActionCancelEventArgs e)
Parameters:eInteractiveActionCancelEventArgs

The InteractiveActionCancelEventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Raises the InteractiveActionLeave event.

C#
protected virtual void OnInteractiveActionLeave(InteractiveActionEventArgs e)
Parameters:eInteractiveActionEventArgs

The InteractiveActionEventArgs that contains the event data.

Initializes the report viewer when it is loaded.

C#
protected override void OnLoad(EventArgs e)
Parameters:eEventArgs

Overrides: UserControl.OnLoad(EventArgs)

Raises the Print event.

C#
[Obsolete("OnPrint method is now obsolete. Please use Telerik.ReportViewer.WinForms.ReportViewer.OnPrintBegin method instead.")]
protected virtual void OnPrint(CancelEventArgs e)
Parameters:eCancelEventArgs

The CancelEventArgs that contains the event data.

Raises the Print event.

C#
[Obsolete("This overload is now obsolete. Please use Telerik.ReportViewer.WinForms.ReportViewer.OnPrintBegin(PrintBeginEventArgs) instead.")]
protected virtual void OnPrintBegin(CancelEventArgs e)
Parameters:eCancelEventArgs

The CancelEventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Raises the Print event.

C#
protected virtual void OnPrintBegin(PrintBeginEventArgs e)
Parameters:ePrintBeginEventArgs

The PrintBeginEventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Raises the PrintEnd event.

C#
[Obsolete("This overload is now obsolete. Please use Telerik.ReportViewer.WinForms.ReportViewer.OnPrintEnd(PrintEndEventArgs) instead.")]
protected virtual void OnPrintEnd(EventArgs e)
Parameters:eEventArgs

The EventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Raises the PrintEnd event.

C#
protected virtual void OnPrintEnd(PrintEndEventArgs e)
Parameters:ePrintEndEventArgs

The PrintEndEventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Raises the RenderingBegin event.

C#
[Obsolete("This overload is now obsolete. Please use Telerik.ReportViewer.WinForms.ReportViewer.OnRenderingBegin(RenderingBeginEventArgs) instead.")]
protected virtual void OnRenderingBegin(CancelEventArgs e)
Parameters:eCancelEventArgs

The CancelEventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Raises the RenderingBegin event.

C#
protected virtual void OnRenderingBegin(RenderingBeginEventArgs e)
Parameters:eRenderingBeginEventArgs

The RenderingBeginEventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Raises the RenderingEnd event.

C#
[Obsolete("This overload is now obsolete. Please use Telerik.ReportViewer.WinForms.ReportViewer.OnRenderingEnd(RenderingEndEventArgs) instead.")]
protected virtual void OnRenderingEnd(EventArgs e)
Parameters:eEventArgs

The EventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Raises the RenderingEnd event.

C#
protected virtual void OnRenderingEnd(RenderingEndEventArgs e)
Parameters:eRenderingEndEventArgs

The RenderingEndEventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Raises the ViewerToolTipOpening event.

C#
protected virtual void OnToolTipExecuting(ToolTipOpeningEventArgs e)
Parameters:eToolTipOpeningEventArgs

The ToolTipOpeningEventArgs that contains the event data.

Raises the UpdateUI event.

C#
protected virtual void OnUpdateUI(EventArgs e)
Parameters:eEventArgs

The EventArgs that contains the event data.

When overridden, make sure you call the base method implementation.

Renders the report in the viewer passing the currently entered parameter values to the report.

C#
public void Preview()

Opens the print dialog for the report

C#
public void PrintReport()
Example:
cs-api-definition
// Opens the dialog to print the report
private void button4_Click(object sender, System.EventArgs e)
{
this.reportViewer1.PrintReport();
}

Prints the report using the specified device information.

C#
protected void PrintReportInternal(Hashtable deviceInfo, PrintBeginEventArgs eventArgs)
Parameters:deviceInfoHashtableeventArgsPrintBeginEventArgs

Capture the keystrokes to determine if a valid accessible area shortcut is pressed

C#
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
Parameters:msgMessagekeyDataKeysReturns:

bool

Overrides: ContainerControl.ProcessCmdKey(ref Message, Keys)

Loads and refreshes the ReportSource in the viewer. Use this method to display in the viewer the report source from the ReportSource property.
Fresh report data is pulled from the report source data sources. Adds new history record in the report history right after the current record and the new record becomes current.
This method should not be called before the Form.Load() event is fired (avoid using it in the Form's constructor).

C#
public void RefreshReport()
Example:
cs-api-definition
// Refresh the report with the current parameters
private void button6_Click(object sender, System.EventArgs e)
{
this.reportViewer1.RefreshReport();
}

Resets the control to its default values.

C#
public void Reset()

Displays a confirmation dialog before navigating to a file.

C#
protected virtual DialogResult ShowNavigateToFileConfirmationDialog(string url)
Parameters:urlstringReturns:

DialogResult

Opens the page setup dialog

C#
public void ShowPageSetupDialog()

Toggles the search dialog to search within the document. If the search metadata is not prepared, invokes report refresh to generate the search metadata and then opens the dialog.

C#
public void ToggleReportContentSearch()

Events

Occurs when the EnableAccessibility property is changed.

C#
public event AccessibilityChangedEventHandler AccessibilityChanged

Occurs when there is an error in the report viewer control.

C#
public event ErrorEventHandler Error
Example:
cs-api-definition
void reportViewer1_Error(object sender, Telerik.Reporting.ErrorEventArgs args)
{
if (args.Exception is System.Exception) // check for a specific exception
{
var message = args.Exception.Message;
// do something with the message and/or the
}
}

Occurs when the report in the viewer control starts exporting.

C#
public event ExportBeginEventHandler ExportBegin

Can be used to modify device info settings, such as report culture, before the export starts

Example:
cs-api-definition
void reportViewer1_ExportBegin(object sender, Telerik.ReportViewer.Common.ExportBeginEventArgs args)
{
if (true) // some logic here
{
// Cancel is false by default
args.Cancel = true;
}

switch (args.Format)
{
case "Excel":
// do something
break;
case "PDF":
// do something
break;
}
}

Occurs when the report exporting in the viewer control is finished.

C#
public event ExportEndEventHandler ExportEnd
Example:
cs-api-definition
void reportViewer1_ExportEnd(object sender, Telerik.ReportViewer.Common.ExportEndEventArgs args)
{
if (null != args.Exception)
{
//some logic if report processing is not successful
}
else
{
//suppress the viewer SaveFileDialog and use your own
args.Handled = true;
var fileName = args.DocumentName;
var extension = args.DocumentExtension;
var filter = string.Format("{0} (*.{1})|*.{1}|All Files (*.*)|*.*",
fileName,
extension);

var saveFileDlg = new SaveFileDialog
{
Filter = filter,
FileName = fileName + "." + extension,
};

if (saveFileDlg.ShowDialog() == DialogResult.OK)
{
try
{
using (var fs = new FileStream(saveFileDlg.FileName, FileMode.Create))
{
fs.Write(args.DocumentBytes, 0, args.DocumentBytes.Length);
}

//Optionally open the file
if (!string.IsNullOrEmpty(saveFileDlg.FileName))
{
System.Diagnostics.Process.Start(saveFileDlg.FileName);
}
}
catch (Exception)
{
//Handle exception
}
}
}
}

Occurs when the mouse cursor enters the area of a report item's action.

C#
public event InteractiveActionEnterEventHandler InteractiveActionEnter
Example:
cs-api-definition
void reportViewer1_InteractiveActionEnter(object sender, Telerik.ReportViewer.Common.InteractiveActionEventArgs args)
{
var strB = new System.Text.StringBuilder();
strB.AppendLine("You have just entered an action area.");
strB.AppendLine("Action type: " + args.Action.GetType().Name);
strB.AppendLine("ReportItem name: " + args.Action.ReportItemName);
strB.AppendLine(string.Format("Mouse cursor position: {0}; Item bounds: {1}", args.CursorPos, args.Bounds));

Console.Out.WriteLine(strB.ToString());
}

Occurs when an action is being executed. Execution can be canceled.

C#
public event InteractiveActionExecutingEventHandler InteractiveActionExecuting
Example:
cs-api-definition
void reportViewer1_CustomInteractiveActionExecuting(object sender, Telerik.ReportViewer.Common.InteractiveActionCancelEventArgs args)
{
var strB = new System.Text.StringBuilder();
strB.AppendLine("ReportItem name: " + args.Action.ReportItemName);

var customAction = args.Action as Telerik.Reporting.Processing.CustomAction;
if (null != customAction)
{
foreach (var p in customAction.Parameters)
{
strB.AppendLine(string.Format("Parameter \"{0}\" value: {1}", p.Key, p.Value));
}
}

strB.AppendLine(string.Format("Mouse cursor position: {0}; Item bounds: {1}", args.CursorPos, args.Bounds));

MessageBox.Show(strB.ToString());
}

Occurs when the mouse cursor leaves the area of a report item's action.

C#
public event InteractiveActionLeaveEventHandler InteractiveActionLeave
Example:
cs-api-definition
void reportViewer1_InteractiveActionLeave(object sender, Telerik.ReportViewer.Common.InteractiveActionEventArgs args)
{
var strB = new System.Text.StringBuilder();
strB.AppendLine("You have just left an action area.");
strB.AppendLine("Action type: " + args.Action.GetType().Name);
strB.AppendLine("ReportItem name: " + args.Action.ReportItemName);
strB.AppendLine(string.Format("Item bounds: {0}", args.Bounds));

Console.Out.WriteLine(strB.ToString());
}

Print

CancelEventHandler

Occurs when the report in the viewer control is printed.

C#
[Obsolete("Print event is now obsolete. Please use Telerik.ReportViewer.WinForms.ReportViewer.PrintBegin event instead.")]
public event CancelEventHandler Print

Occurs when the report in the viewer control starts printing.

C#
public event PrintBeginEventHandler PrintBegin
Example:
cs-api-definition
void reportViewer1_PrintBegin(object sender, Telerik.ReportViewer.Common.PrintBeginEventArgs e)
{
if (true) // some logic here
{
// Cancel is false by default
e.Cancel = true;
}

//To prevent the Print Dialog from appearing, you should specify valid printer settings to this method.
if (true)
{
// Obtain the settings of the default printer
e.PrinterSettings = new System.Drawing.Printing.PrinterSettings();

// To suppress the Print dialogs. The standard print controller comes with no UI
e.PrintController = new System.Drawing.Printing.StandardPrintController();
}
}

Occurs when the report printing in the viewer control is finished.

C#
public event PrintEndEventHandler PrintEnd
Example:
cs-api-definition
Private Sub reportViewer1_PrintEnd(sender As Object, e As Telerik.ReportViewer.Common.PrintEndEventArgs)

' suitable for logging and triggering other actions

End Sub

Occurs when the report in the viewer control starts rendering.

C#
public event RenderingBeginEventHandler RenderingBegin

Can be used to modify device info settings, such as report culture, before the rendering starts

Example:
cs-api-definition
void reportViewer1_RenderingBegin(object sender, Telerik.ReportViewer.Common.RenderingBeginEventArgs e)
{
if (true) // some logic here
{
// Cancel is false by default
e.Cancel = true;
}
}

Occurs when the report rendering in the viewer control is finished.

C#
public event RenderingEndEventHandler RenderingEnd
Example:
cs-api-definition
void reportViewer1_RenderingEnd(object sender, Telerik.ReportViewer.Common.RenderingEndEventArgs e)
{
// suitable for logging and triggering other actions
}

UpdateUI

EventHandler

Occurs when the UI of the report viewer control is updated.

C#
public event EventHandler UpdateUI
Example:
cs-api-definition
void reportViewer1_UpdateUI(object sender, System.EventArgs e)
{
// invoked whenever the viewer state is changed
}

ViewerAreaPaint

PaintEventHandler

Occurs when the viewer's area is painted.

C#
public event PaintEventHandler ViewerAreaPaint

Occurs when the tooltip, associated with a report item, is being opened

C#
public event ToolTipOpeningEventHandler ViewerToolTipOpening
Example:
cs-api-definition
private void reportViewer1_ViewerToolTipOpening(object sender, Telerik.ReportViewer.Common.ToolTipOpeningEventArgs args)
{
if (args.ToolTip.Title.Contains("DoNotShow"))
{
args.Cancel = true;
}
else
{
args.ToolTip.Title = "The tooltip title is changed!";
args.ToolTip.Text += " (changed)";
}
}
In this article
DefinitionPropertiesAccessibilityKeyMapAllowNavigatingToFileUrlsCurrentPageDocumentMapVisibleEnableAccessibilityNavigateBackEnabledNavigateForwardEnabledParametersAreaVisibleProcessingStateRenderingExtensionsReportReportEngineConnectionReportSourceReportViewerModelResourcesSearchMetadataOnDemandShowDocumentMapButtonShowExportButtonShowHistoryButtonsShowPageNavigationControlsShowPageSetupShowPageSetupButtonShowParametersButtonShowPrintButtonShowPrintPreviewButtonShowProgressShowRefreshButtonShowSearchButtonShowStopButtonShowZoomToolbarVisibleTotalPagesViewModeZoomModeZoomPercentMethodsAddToRenderingContext(IDictionary)CancelRendering()CancelRendering(int)CanMoveToPage(int)ClearHistory()Dispose(bool)ExportReport(string, Hashtable)FormatNavigateToFileConfirmation(string)HandleNavigateToFileActionNotSupported(NotSupportedException)NavigateBack()NavigateForward()OnError(ErrorEventArgs)OnExportBegin(ExportBeginEventArgs)OnExportEnd(ExportEndEventArgs)OnInteractiveActionEnter(InteractiveActionEventArgs)OnInteractiveActionExecuting(InteractiveActionCancelEventArgs)OnInteractiveActionLeave(InteractiveActionEventArgs)OnLoad(EventArgs)OnPrint(CancelEventArgs)OnPrintBegin(CancelEventArgs)OnPrintBegin(PrintBeginEventArgs)OnPrintEnd(EventArgs)OnPrintEnd(PrintEndEventArgs)OnRenderingBegin(CancelEventArgs)OnRenderingBegin(RenderingBeginEventArgs)OnRenderingEnd(EventArgs)OnRenderingEnd(RenderingEndEventArgs)OnToolTipExecuting(ToolTipOpeningEventArgs)OnUpdateUI(EventArgs)Preview()PrintReport()PrintReportInternal(Hashtable, PrintBeginEventArgs)ProcessCmdKey(ref Message, Keys)RefreshReport()Reset()ShowNavigateToFileConfirmationDialog(string)ShowPageSetupDialog()ToggleReportContentSearch()EventsAccessibilityChangedErrorExportBeginExportEndInteractiveActionEnterInteractiveActionExecutingInteractiveActionLeavePrintPrintBeginPrintEndRenderingBeginRenderingEndUpdateUIViewerAreaPaintViewerToolTipOpening
Not finding the help you need?
Contact Support