Render(IRenderingExtension,StreamProvider,NameValueCollection,Boolean,Boolean,CancellationToken) Method

In This Topic

Renders a report using the specified rendering extension with the specified values and refreshed data.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Sub Render( _
   ByVal renderingExtension As IRenderingExtension, _
   ByVal streams As StreamProvider, _
   ByVal settings As NameValueCollection, _
   ByVal forceDataRefresh As Boolean, _
   ByVal forceParameterDataRefresh As Boolean, _
   ByVal token As CancellationToken _
)

public void Render( 
   IRenderingExtension renderingExtension,
   StreamProvider streams,
   NameValueCollection settings,
   bool forceDataRefresh,
   bool forceParameterDataRefresh,
   CancellationToken token
)

Parameters

renderingExtension
streams: The GrapeCity.ActiveReports.Extensibility.Rendering.IO.StreamProvider to store the rendered report output.
settings: The System.Collections.Specialized.NameValueCollection that contains the settings for the GrapeCity.ActiveReports.Extensibility.Rendering.IRenderingExtension.
forceDataRefresh: Set to True to force a refresh or query of the data even if the DataMap has already retrieved the required data.
forceParameterDataRefresh: Set to True to force a refresh or query of the parameter data.
token: Allows to stop rendering

Exceptions

Exception	Description
System.ArgumentNullException	Thrown if the renderingExtension or streams is null.
GrapeCity.ActiveReports.ReportException	Thrown if a report-specific error occured.
System.ComponentModel.LicenseException	Thrown when a component cannot be granted a license.
GrapeCity.ActiveReports.Rdl.Validation.ValidationReportException	Thrown if validation problems occurred.
GrapeCity.ActiveReports.Core.Rendering.ReportParameters.ReportParameterException	Thrown when an error related to a report's parameter occurs.
System.OperationCanceledException	Thrown in a thread upon cancellation of an operation that the thread was executing.

Example

private CancellationTokenSource _cancellationTokenSource;
private async void ExportAsync(PageReport report, IRenderingExtension renderingExtension, FileStreamProvider outputProvider, NameValueCollection settings)
{
	_cancellationTokenSource = new CancellationTokenSource();
	cancelButton.Text = "Cancel";
	await Task.Run(() =>
	{
		try
		{
			report.Document.Render(renderingExtension, outputProvider, settings, false, false, _cancellationTokenSource.Token);
		}
		catch (OperationCanceledException)
		{
		}
	});
	if (_cancellationTokenSource.IsCancellationRequested)
	MessageBox.Show("Export was cancelled", "Export", MessageBoxButtons.OK, MessageBoxIcon.Information);
	_cancellationTokenSource.Dispose();
}
private void cancelExport(object sender, EventArgs e)
{
	_cancellationTokenSource?.Cancel();
}

Reference

PageDocument Class
PageDocument Members
Overload List