Documentation

Class GridViewSpreadStreamExport

Represents a grid export that utilizes the RadSpreadStreamProcessing library.

Inheritance
System.Object
GridViewSpreadStreamExport
Namespace: Telerik.Windows.Controls.GridView.SpreadsheetStreamingExport
Assembly: Telerik.Windows.Controls.GridView.SpreadsheetStreamingExport.dll

Syntax

public class GridViewSpreadStreamExport : Object

Constructors

GridViewSpreadStreamExport(RadGridView)

Initializes a new instance of the GridViewSpreadStreamExport class.

Declaration
public GridViewSpreadStreamExport(RadGridView radGridView)
Parameters
RadGridView radGridView

The grid to export.

GridViewSpreadStreamExport(RadGridView, SpreadStreamExportFormat)

Initializes a new instance of the GridViewSpreadStreamExport class.

Declaration
public GridViewSpreadStreamExport(RadGridView radGridView, SpreadStreamExportFormat spreadExportFormat)
Parameters
RadGridView radGridView

The grid to export.
SpreadStreamExportFormat spreadExportFormat

The spread export format.

Properties

ExportFormat

Gets or sets the format of the exported file - XLSX or CSV.

Declaration
public SpreadStreamExportFormat ExportFormat { get; set; }
Property Value
SpreadStreamExportFormat

The file extension.

SheetName

Gets or sets the name of the sheet.

Declaration
public string SheetName { get; set; }
Property Value
System.String

The name of the sheet.

ShowLoadingIndicatorWhileAsyncExport

Gets or sets a value indicating whether a RadBusyIndicator will be shown while async export operation is running.

Declaration
public bool ShowLoadingIndicatorWhileAsyncExport { get; set; }
Property Value
System.Boolean

Methods

CancelExportAsync()

Cancels an asynchronous export operation.

Declaration
public void CancelExportAsync()

OnAsyncExportCompleted(AsyncCompletedEventArgs)

Raises the AsyncExportCompleted event.

Declaration
protected virtual void OnAsyncExportCompleted(AsyncCompletedEventArgs e)
Parameters
System.ComponentModel.AsyncCompletedEventArgs e

The System.ComponentModel.AsyncCompletedEventArgs instance containing the event data.

OnAsyncExportProgressChanged(ProgressChangedEventArgs)

Raises the AsyncExportProgressChanged event.

Declaration
protected virtual void OnAsyncExportProgressChanged(ProgressChangedEventArgs e)
Parameters
System.ComponentModel.ProgressChangedEventArgs e

The System.ComponentModel.ProgressChangedEventArgs instance containing the event data.

OnExportCompleted(EventArgs)

Raises the ExportCompleted event.

Declaration
protected virtual void OnExportCompleted(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.

RunExport(Stream, SpreadStreamExportRenderer)

Starts an export operation.

Declaration
public void RunExport(Stream exportStream, SpreadStreamExportRenderer exportRenderer)
Parameters
System.IO.Stream exportStream

The stream where data will be exported.
SpreadStreamExportRenderer exportRenderer

Instance of SpreadStreamExportRenderer class.

RunExport(Stream, SpreadStreamExportRenderer, GridViewSpreadStreamExportOptions)

Starts an export operation, in the specified sheet. If such sheet does not exist, it gets created.

Declaration
public void RunExport(Stream exportStream, SpreadStreamExportRenderer exportRenderer, GridViewSpreadStreamExportOptions options)
Parameters
System.IO.Stream exportStream

The stream where data will be exported.
SpreadStreamExportRenderer exportRenderer

Instance of SpreadStreamExportRenderer class.
GridViewSpreadStreamExportOptions options

The GridViewSpreadStreamExport options.

RunExport(String, SpreadStreamExportRenderer)

Starts an export operation.

Declaration
public void RunExport(string fileName, SpreadStreamExportRenderer exportRenderer)
Parameters
System.String fileName

The file name where data will be exported.
SpreadStreamExportRenderer exportRenderer

Instance of SpreadStreamExportRenderer class.

RunExport(String, SpreadStreamExportRenderer, GridViewSpreadStreamExportOptions)

Starts an export operation, in the specified sheet. If such sheet does not exist, it gets created.

Declaration
public void RunExport(string fileName, SpreadStreamExportRenderer exportRenderer, GridViewSpreadStreamExportOptions options)
Parameters
System.String fileName

The file name where data will be exported.
SpreadStreamExportRenderer exportRenderer

Instance of SpreadStreamExportRenderer class.
GridViewSpreadStreamExportOptions options

The GridViewSpreadStreamExport options.

RunExportAsync(Stream, SpreadStreamExportRenderer)

Starts an export operation that runs in a background thread.

Declaration
public void RunExportAsync(Stream exportStream, SpreadStreamExportRenderer exportRenderer)
Parameters
System.IO.Stream exportStream

The stream where data will be exported.
SpreadStreamExportRenderer exportRenderer

Instance of SpreadStreamExportRenderer class.

RunExportAsync(Stream, SpreadStreamExportRenderer, GridViewSpreadStreamExportOptions)

Starts an async export operation, in the specified sheet. If such sheet does not exist, it gets created.

Declaration
public void RunExportAsync(Stream exportStream, SpreadStreamExportRenderer exportRenderer, GridViewSpreadStreamExportOptions options)
Parameters
System.IO.Stream exportStream

The stream where data will be exported.
SpreadStreamExportRenderer exportRenderer

Instance of SpreadStreamExportRenderer class.
GridViewSpreadStreamExportOptions options

The GridViewSpreadStreamExport options.

RunExportAsync(String, SpreadStreamExportRenderer)

Starts an export operation that runs in a background thread.

Declaration
public void RunExportAsync(string fileName, SpreadStreamExportRenderer exportRenderer)
Parameters
System.String fileName

The file name where data will be exported.
SpreadStreamExportRenderer exportRenderer

Instance of SpreadStreamExportRenderer class.

RunExportAsync(String, SpreadStreamExportRenderer, GridViewSpreadStreamExportOptions)

Starts an async export operation, in the specified sheet. If such sheet does not exist, it gets created.

Declaration
public void RunExportAsync(string fileName, SpreadStreamExportRenderer exportRenderer, GridViewSpreadStreamExportOptions options)
Parameters
System.String fileName

The file name where data will be exported.
SpreadStreamExportRenderer exportRenderer

Instance of SpreadStreamExportRenderer class.
GridViewSpreadStreamExportOptions options

The GridViewSpreadStreamExport options.

Events

AsyncExportCompleted

Occurs when an async export operation is completed.

Declaration
public event AsyncCompletedEventHandler AsyncExportCompleted
Event Type
System.ComponentModel.AsyncCompletedEventHandler

AsyncExportProgressChanged

Occurs when the progress of an async export operation changes.

Declaration
public event ProgressChangedEventHandler AsyncExportProgressChanged
Event Type
System.ComponentModel.ProgressChangedEventHandler

ElementExportedToDocument

Occurs after element export to XLSX or CSV.

Declaration
public event EventHandler<GridViewSpreadStreamElementExportedEventArgs> ElementExportedToDocument
Event Type
System.EventHandler<GridViewSpreadStreamElementExportedEventArgs>

ElementExportingToDocument

Occurs before element export to XLSX or CSV.

Declaration
public event EventHandler<GridViewSpreadStreamElementExportingEventArgs> ElementExportingToDocument
Event Type
System.EventHandler<GridViewSpreadStreamElementExportingEventArgs>

ExportCompleted

Occurs when the export process completes.

Declaration
public event EventHandler ExportCompleted
Event Type
System.EventHandler

Extension Methods