Documentation

Class ListViewSpreadExport

ListViewSpreadExport is a powerful exporting API, allowing to export RadListView to XLSX, PDF, CSV, and TXT format, utilizing the Document Processing Libraries.

Inheritance
System.Object
ListViewSpreadExport
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.Export
Assembly: Telerik.WinControls.UI.dll

Syntax

public class ListViewSpreadExport

Constructors

ListViewSpreadExport(RadListView)

Initializes a new instance of the ListViewSpreadExport class.

Declaration
public ListViewSpreadExport(RadListView radListView)
Parameters
RadListView radListView

The ListView to export.

ListViewSpreadExport(RadListView, SpreadExportFormat)

Initializes a new instance of the ListViewSpreadExport class.

Declaration
public ListViewSpreadExport(RadListView radListView, SpreadExportFormat exportFormat)
Parameters
RadListView radListView

The ListView to export.
SpreadExportFormat exportFormat

The export format.

Properties

CollapsedItemOption

Gets or sets a value indicating how children of collapsed items are exported.

Declaration
public HiddenOption CollapsedItemOption { get; set; }
Property Value
HiddenOption

ExportChildItemsGrouped

Gets or sets a value indicating whether to export hierarchy and group child rows grouped.

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

ExportFormat

Gets or sets the format of the exported file - XLSX, PDF, CSV, TXT or XLS.

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

The file extension.

ExportImages

Gets or sets a value indicating whether to export images.

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

ExportVisualSettings

Gets or sets a value indicating whether the visual settings should be exported.

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

true if visual settings are exported; otherwise, false.

FileExportMode

Specifies how the file will be exported: as a new file, a new sheet in existing file or will override a sheet with given name.

Declaration
public FileExportMode FileExportMode { get; set; }
Property Value
FileExportMode

NewSheetInExistingFile - will add a new sheet to the specified file, if it exists CreateOrOverrideFile - will create/override the specified file CreateOrOverrideSheet - will create/override the specified sheet

SheetMaxRows

Gets or sets the maximum number of rows per sheet.

Declaration
[CLSCompliant(false)]
public ExcelMaxRows SheetMaxRows { get; set; }
Property Value
ExcelMaxRows

The sheet max rows.

SheetName

Gets or sets the name of the sheet.

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

The name of the sheet.

Methods

CancelExportAsync()

Cancels an asynchronous export operation.

Declaration
public void CancelExportAsync()

CreateImageOverCell(ListViewSpreadExportCell, Int32, Int32)

Declaration
protected virtual void CreateImageOverCell(ListViewSpreadExportCell cell, int currentRowIndex, int currentColumnIndex)
Parameters
ListViewSpreadExportCell cell

System.Int32 currentRowIndex

System.Int32 currentColumnIndex

CreateSpreadExportCell(ListViewDataItem, Boolean)

Declaration
protected virtual ListViewSpreadExportCell CreateSpreadExportCell(ListViewDataItem listViewDataItem, bool exportAsHidden)
Parameters
ListViewDataItem listViewDataItem

System.Boolean exportAsHidden

Returns
ListViewSpreadExportCell

CreateTextCell(ListViewSpreadExportCell, Int32, Int32)

Declaration
protected virtual void CreateTextCell(ListViewSpreadExportCell cell, int currentRowIndex, int currentColumnIndex)
Parameters
ListViewSpreadExportCell cell

System.Int32 currentRowIndex

System.Int32 currentColumnIndex

CreateVisualItem(ListViewDataItem)

Declaration
protected virtual BaseListViewVisualItem CreateVisualItem(ListViewDataItem listViewDataItem)
Parameters
ListViewDataItem listViewDataItem

Returns
BaseListViewVisualItem

GetStylesFromVisualCell(ListViewSpreadExportCell, LightVisualElement)

Declaration
protected virtual void GetStylesFromVisualCell(ListViewSpreadExportCell cell, LightVisualElement visualCell)
Parameters
ListViewSpreadExportCell cell

LightVisualElement visualCell

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.

OnCellFormatting(ListViewSpreadExportCellFormattingEventArgs)

Raises the CellFormatting event.

Declaration
protected virtual void OnCellFormatting(ListViewSpreadExportCellFormattingEventArgs e)
Parameters
ListViewSpreadExportCellFormattingEventArgs e

The ListViewSpreadExportCellFormattingEventArgs 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.

ReleaseVisualItem(BaseListViewVisualItem)

Declaration
protected virtual void ReleaseVisualItem(BaseListViewVisualItem visualItem)
Parameters
BaseListViewVisualItem visualItem

RunExport(Stream, ISpreadExportRenderer)

Starts an export operation.

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

The stream where data will be exported.
ISpreadExportRenderer exportRenderer

Instance of ISpreadExportRenderer class.

RunExport(Stream, ISpreadExportRenderer, String)

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

Declaration
public void RunExport(Stream exportStream, ISpreadExportRenderer exportRenderer, string sheetName)
Parameters
System.IO.Stream exportStream

The stream where data will be exported.
ISpreadExportRenderer exportRenderer

Instance of ISpreadExportRenderer class.
System.String sheetName

Name of the sheet.

RunExport(String, ISpreadExportRenderer)

Starts an export operation.

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

The file name where data will be exported.
ISpreadExportRenderer exportRenderer

Instance of ISpreadExportRenderer class.

RunExport(String, ISpreadExportRenderer, String)

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

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

The file name where data will be exported.
ISpreadExportRenderer exportRenderer

Instance of ISpreadExportRenderer class.
System.String sheetName

Name of the sheet.

RunExportAsync(Stream, ISpreadExportRenderer)

Starts an export operation that runs in a background thread. Note that if ExportVisualSettings is true, collecting the visual styles from the RadListView will still execute on the UI thread.

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

The stream where data will be exported.
ISpreadExportRenderer exportRenderer

Instance of ISpreadExportRenderer class.

RunExportAsync(Stream, ISpreadExportRenderer, String)

Starts an async export operation, in the specified sheet. If such sheet does not exist, it gets created. Note that if ExportVisualSettings is true, collecting the visual styles from the RadListView will still execute on the UI thread.

Declaration
public void RunExportAsync(Stream exportStream, ISpreadExportRenderer exportRenderer, string sheetName)
Parameters
System.IO.Stream exportStream

The stream where data will be exported.
ISpreadExportRenderer exportRenderer

Instance of ISpreadExportRenderer class.
System.String sheetName

Name of the sheet.

RunExportAsync(String, ISpreadExportRenderer)

Starts an export operation that runs in a background thread. Note that if ExportVisualSettings is true, collecting the visual styles from the RadListView will still execute on the UI thread.

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

The file name where data will be exported.
ISpreadExportRenderer exportRenderer

Instance of ISpreadExportRenderer class.

RunExportAsync(String, ISpreadExportRenderer, String)

Starts an async export operation, in the specified sheet. If such sheet does not exist, it gets created. Note that if ExportVisualSettings is true, collecting the visual styles from the RadListView will still execute on the UI thread.

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

The file name where data will be exported.
ISpreadExportRenderer exportRenderer

Instance of ISpreadExportRenderer class.
System.String sheetName

Name of the sheet.

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

CellFormatting

Occurs for every cell that is being exported.

Declaration
public event ListViewSpreadExportCellFormattingEventHandler CellFormatting
Event Type
ListViewSpreadExportCellFormattingEventHandler

ExportCompleted

Occurs when the export process completes.

Declaration
public event EventHandler ExportCompleted
Event Type
System.EventHandler

Extension Methods