ClassGridViewSpreadStreamExport
Represents a grid export that utilizes the RadSpreadStreamProcessing library.
Definition
Namespace:Telerik.Windows.Controls.GridView.SpreadsheetStreamingExport
Assembly:Telerik.Windows.Controls.GridView.SpreadsheetStreamingExport.dll
Syntax:
[SuppressMessage("Microsoft.Design", "CA1001:TypesThatOwnDisposableFieldsShouldBeDisposable")]
public class GridViewSpreadStreamExportInheritance: objectGridViewSpreadStreamExport
Constructors
GridViewSpreadStreamExport(RadGridView)
Initializes a new instance of the GridViewSpreadStreamExport class.
Declaration
public GridViewSpreadStreamExport(RadGridView radGridView)Parameters
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
The grid to export.
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
The file extension.
SheetName
Gets or sets the name of the sheet.
Declaration
public string SheetName { get; set; }Property Value
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
Methods
CancelExportAsync()
Cancels an asynchronous export operation.
Declaration
public void CancelExportAsync()OnAsyncExportCompleted(AsyncCompletedEventArgs)
Raises the event.
Declaration
protected virtual void OnAsyncExportCompleted(AsyncCompletedEventArgs e)Parameters
e
The AsyncCompletedEventArgs instance containing the event data.
OnAsyncExportProgressChanged(ProgressChangedEventArgs)
Raises the event.
Declaration
protected virtual void OnAsyncExportProgressChanged(ProgressChangedEventArgs e)Parameters
e
The ProgressChangedEventArgs instance containing the event data.
OnExportCompleted(EventArgs)
Raises the event.
RunExport(Stream, SpreadStreamExportRenderer)
Starts an export operation.
Declaration
public void RunExport(Stream exportStream, SpreadStreamExportRenderer exportRenderer)Parameters
exportStream
The stream where data will be exported.
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
exportStream
The stream where data will be exported.
exportRenderer
Instance of SpreadStreamExportRenderer class.
options
GridViewSpreadStreamExportOptions
The GridViewSpreadStreamExport options.
RunExport(string, SpreadStreamExportRenderer)
Starts an export operation.
Declaration
public void RunExport(string fileName, SpreadStreamExportRenderer exportRenderer)Parameters
fileName
The file name where data will be exported.
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
fileName
The file name where data will be exported.
exportRenderer
Instance of SpreadStreamExportRenderer class.
options
GridViewSpreadStreamExportOptions
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
exportStream
The stream where data will be exported.
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
exportStream
The stream where data will be exported.
exportRenderer
Instance of SpreadStreamExportRenderer class.
options
GridViewSpreadStreamExportOptions
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
fileName
The file name where data will be exported.
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
fileName
The file name where data will be exported.
exportRenderer
Instance of SpreadStreamExportRenderer class.
options
GridViewSpreadStreamExportOptions
The GridViewSpreadStreamExport options.
Events
AsyncExportCompleted
Occurs when an async export operation is completed.
Declaration
public event AsyncCompletedEventHandler AsyncExportCompletedEvent Value
AsyncExportProgressChanged
Occurs when the progress of an async export operation changes.
Declaration
public event ProgressChangedEventHandler AsyncExportProgressChangedEvent Value
ElementExportedToDocument
Occurs after element export to XLSX or CSV.
Declaration
public event EventHandler<GridViewSpreadStreamElementExportedEventArgs> ElementExportedToDocumentEvent Value
ElementExportingToDocument
Occurs before element export to XLSX or CSV.
Declaration
public event EventHandler<GridViewSpreadStreamElementExportingEventArgs> ElementExportingToDocumentEvent Value
ExportCompleted
Occurs when the export process completes.