ReportViewer.CancelRendering Method

  • Article

Stops background processing of the report.

Namespace: Microsoft.Reporting.WinForms
Assembly: Microsoft.ReportViewer.WinForms (in microsoft.reportviewer.winforms.dll)

Syntax

'Declaration
Public Function CancelRendering ( _
    millisecondsTimeout As Integer _
) As Boolean

'Usage
Dim instance As ReportViewer
Dim millisecondsTimeout As Integer
Dim returnValue As Boolean

returnValue = instance.CancelRendering(millisecondsTimeout)

public bool CancelRendering (
    int millisecondsTimeout
)

public:
bool CancelRendering (
    int millisecondsTimeout
)

public boolean CancelRendering (
    int millisecondsTimeout
)

public function CancelRendering (
    millisecondsTimeout : int
) : boolean

Parameters

  • millisecondsTimeout
    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

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.

See Also

Reference

ReportViewer Class
ReportViewer Members
Microsoft.Reporting.WinForms Namespace