Progress® Telerik® Reporting R3 2021

ReportViewerBase.CancelRendering Method (Int32)

Note: This API is now obsolete.

Stops background processing of the report.

Namespace:  Telerik.ReportViewer.WinForms
Assembly:  Telerik.ReportViewer.WinForms (in Telerik.ReportViewer.WinForms.dll)

Syntax

C#

VB

Copy

[ObsoleteAttribute("CancelRendering(int timeout) method is now obsolete. Please use the Telerik.ReportViewer.WinForms.ReportViewer.CancelRendering() method instead.")]
public bool CancelRendering(
	int timeout
)

<ObsoleteAttribute("CancelRendering(int timeout) method is now obsolete. Please use the Telerik.ReportViewer.WinForms.ReportViewer.CancelRendering() method instead.")>
Public Function CancelRendering ( 
	timeout As Integer
) As Boolean

Parameters

timeout

Type: SystemInt32
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.

Return Value

Type: Boolean
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.

Examples

C#

VB

Copy

// Stop rendering the report. 
private void button1_Click(object sender, System.EventArgs e)
{
    this.reportViewer1.CancelRendering();
}

' Stop rendering the report. 
Private Sub button1_Click(sender As Object, e As System.EventArgs)
    Me.ReportViewer1.CancelRendering()
End Sub

Version Information

Obsolete (compiler warning) in 1.0.1

See Also

Reference

ReportViewerBase Class

CancelRendering Overload

Telerik.ReportViewer.WinForms Namespace