Represents a grid export that utilizes the RadSpreadStreamProcessing library.
Definition
Namespace:Telerik.Windows.Controls.GridView.SpreadsheetStreamingExport
Assembly:Telerik.Windows.Controls.GridView.SpreadsheetStreamingExport.dll
Syntax:
public class GridViewSpreadStreamExportInheritance: objectGridViewSpreadStreamExport
Constructors
Initializes a new instance of the GridViewSpreadStreamExport class.
public GridViewSpreadStreamExport(RadGridView radGridView, SpreadStreamExportFormat spreadExportFormat)The grid to export.
spreadExportFormatSpreadStreamExportFormatThe spread export format.
Initializes a new instance of the GridViewSpreadStreamExport class.
public GridViewSpreadStreamExport(RadGridView radGridView)The grid to export.
Properties
Gets or sets the format of the exported file - XLSX or CSV.
public SpreadStreamExportFormat ExportFormat { get; set; }The file extension.
Gets or sets the name of the sheet.
public string SheetName { get; set; }The name of the sheet.
Gets or sets a value indicating whether a RadBusyIndicator will be shown while async export operation is running.
public bool ShowLoadingIndicatorWhileAsyncExport { get; set; }Methods
Cancels an asynchronous export operation.
public void CancelExportAsync()Raises the event.
protected virtual void OnAsyncExportCompleted(AsyncCompletedEventArgs e)The AsyncCompletedEventArgs instance containing the event data.
Raises the event.
protected virtual void OnAsyncExportProgressChanged(ProgressChangedEventArgs e)The ProgressChangedEventArgs instance containing the event data.
Starts an export operation, in the specified sheet. If such sheet does not exist, it gets created.
public void RunExport(Stream exportStream, SpreadStreamExportRenderer exportRenderer, GridViewSpreadStreamExportOptions options)The stream where data will be exported.
exportRendererSpreadStreamExportRendererInstance of SpreadStreamExportRenderer class.
optionsGridViewSpreadStreamExportOptionsThe GridViewSpreadStreamExport options.
Starts an export operation.
public void RunExport(Stream exportStream, SpreadStreamExportRenderer exportRenderer)The stream where data will be exported.
exportRendererSpreadStreamExportRendererInstance of SpreadStreamExportRenderer class.
Starts an export operation, in the specified sheet. If such sheet does not exist, it gets created.
public void RunExport(string fileName, SpreadStreamExportRenderer exportRenderer, GridViewSpreadStreamExportOptions options)The file name where data will be exported.
exportRendererSpreadStreamExportRendererInstance of SpreadStreamExportRenderer class.
optionsGridViewSpreadStreamExportOptionsThe GridViewSpreadStreamExport options.
Starts an export operation.
public void RunExport(string fileName, SpreadStreamExportRenderer exportRenderer)The file name where data will be exported.
exportRendererSpreadStreamExportRendererInstance of SpreadStreamExportRenderer class.
Starts an async export operation, in the specified sheet. If such sheet does not exist, it gets created.
public void RunExportAsync(Stream exportStream, SpreadStreamExportRenderer exportRenderer, GridViewSpreadStreamExportOptions options)The stream where data will be exported.
exportRendererSpreadStreamExportRendererInstance of SpreadStreamExportRenderer class.
optionsGridViewSpreadStreamExportOptionsThe GridViewSpreadStreamExport options.
Starts an export operation that runs in a background thread.
public void RunExportAsync(Stream exportStream, SpreadStreamExportRenderer exportRenderer)The stream where data will be exported.
exportRendererSpreadStreamExportRendererInstance of SpreadStreamExportRenderer class.
Starts an async export operation, in the specified sheet. If such sheet does not exist, it gets created.
public void RunExportAsync(string fileName, SpreadStreamExportRenderer exportRenderer, GridViewSpreadStreamExportOptions options)The file name where data will be exported.
exportRendererSpreadStreamExportRendererInstance of SpreadStreamExportRenderer class.
optionsGridViewSpreadStreamExportOptionsThe GridViewSpreadStreamExport options.
Starts an export operation that runs in a background thread.
public void RunExportAsync(string fileName, SpreadStreamExportRenderer exportRenderer)The file name where data will be exported.
exportRendererSpreadStreamExportRendererInstance of SpreadStreamExportRenderer class.
Events
Occurs when an async export operation is completed.
public event AsyncCompletedEventHandler AsyncExportCompletedOccurs when the progress of an async export operation changes.
public event ProgressChangedEventHandler AsyncExportProgressChangedOccurs after element export to XLSX or CSV.
public event EventHandler<GridViewSpreadStreamElementExportedEventArgs> ElementExportedToDocumentOccurs before element export to XLSX or CSV.
public event EventHandler<GridViewSpreadStreamElementExportingEventArgs> ElementExportingToDocumentOccurs when the export process completes.
public event EventHandler ExportCompleted