ListViewSpreadExport
ListViewSpreadExport is a powerful exporting API, allowing to export RadListView to XLSX, PDF, CSV, and TXT format, utilizing the Document Processing Libraries.
Definition
Namespace:Telerik.WinControls.Export
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class ListViewSpreadExportInheritance: objectListViewSpreadExport
Constructors
Initializes a new instance of the ListViewSpreadExport class.
public ListViewSpreadExport(RadListView radListView, SpreadExportFormat exportFormat)The ListView to export.
exportFormatSpreadExportFormatThe export format.
Initializes a new instance of the ListViewSpreadExport class.
public ListViewSpreadExport(RadListView radListView)The ListView to export.
Properties
Gets or sets a value indicating how children of collapsed items are exported.
public HiddenOption CollapsedItemOption { get; set; }Gets or sets a value indicating whether to export hierarchy and group child rows grouped.
public bool ExportChildItemsGrouped { get; set; }Gets or sets the format of the exported file - XLSX, PDF, CSV, TXT or XLS.
public SpreadExportFormat ExportFormat { get; set; }The file extension.
Gets or sets a value indicating whether to export images.
public bool ExportImages { get; set; }Gets or sets a value indicating whether the visual settings should be exported.
public bool ExportVisualSettings { get; set; }true if visual settings are exported; otherwise, false.
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.
public FileExportMode FileExportMode { get; set; }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
Gets or sets the maximum number of rows per sheet.
[CLSCompliant(false)]
public ExcelMaxRows SheetMaxRows { get; set; }The sheet max rows.
Methods
Cancels an asynchronous export operation.
public void CancelExportAsync()Writes the cell image and its style information to the current worksheet position.
protected virtual void CreateImageOverCell(ListViewSpreadExportCell cell, int currentRowIndex, int currentColumnIndex)The export cell containing image and formatting data.
currentRowIndexintThe zero-based worksheet row index.
currentColumnIndexintThe zero-based worksheet column index.
Creates an export cell from an item's text, size, alignment, and optionally its image.
protected virtual ListViewSpreadExportCell CreateSpreadExportCell(ListViewDataItem listViewDataItem, bool exportAsHidden)The item whose content is exported.
exportAsHiddenboolWhether the cell should have zero height because its item is hidden.
Returns:The export-cell representation of the item.
Writes the cell's typed value or text, format, and style information to the current worksheet position.
protected virtual void CreateTextCell(ListViewSpreadExportCell cell, int currentRowIndex, int currentColumnIndex)The export cell containing value and formatting data.
currentRowIndexintThe zero-based worksheet row index.
currentColumnIndexintThe zero-based worksheet column index.
Creates and attaches a temporary visual item when visual settings are included in the export.
protected virtual BaseListViewVisualItem CreateVisualItem(ListViewDataItem listViewDataItem)The data item represented by the visual item.
Returns:The attached visual item, or null when visual settings are not exported.
Copies typography, alignment, fill, and border settings from a visual cell into an export cell.
protected virtual void GetStylesFromVisualCell(ListViewSpreadExportCell cell, LightVisualElement visualCell)The export cell that receives the styles.
visualCellLightVisualElementThe visual cell whose styles are copied.
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.
Raises the event.
protected virtual void OnCellFormatting(ListViewSpreadExportCellFormattingEventArgs e)The ListViewSpreadExportCellFormattingEventArgs instance containing the event data.
Detaches the temporary visual item, returns it to the element provider cache, and removes it from the view tree.
protected virtual void ReleaseVisualItem(BaseListViewVisualItem visualItem)The temporary visual item to release.
Starts an export operation, in the specified sheet. If such sheet does not exist, it gets created.
public void RunExport(Stream exportStream, ISpreadExportRenderer exportRenderer, string sheetName)The stream where data will be exported.
exportRendererISpreadExportRendererInstance of ISpreadExportRenderer class.
sheetNamestringName of the sheet.
Starts an export operation.
public void RunExport(Stream exportStream, ISpreadExportRenderer exportRenderer)The stream where data will be exported.
exportRendererISpreadExportRendererInstance of ISpreadExportRenderer class.
Starts an export operation, in the specified sheet. If such sheet does not exist, it gets created.
public void RunExport(string fileName, ISpreadExportRenderer exportRenderer, string sheetName)The file name where data will be exported.
exportRendererISpreadExportRendererInstance of ISpreadExportRenderer class.
sheetNamestringName of the sheet.
Starts an export operation.
public void RunExport(string fileName, ISpreadExportRenderer exportRenderer)The file name where data will be exported.
exportRendererISpreadExportRendererInstance of ISpreadExportRenderer class.
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.
public void RunExportAsync(Stream exportStream, ISpreadExportRenderer exportRenderer, string sheetName)The stream where data will be exported.
exportRendererISpreadExportRendererInstance of ISpreadExportRenderer class.
sheetNamestringName of the sheet.
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.
public void RunExportAsync(Stream exportStream, ISpreadExportRenderer exportRenderer)The stream where data will be exported.
exportRendererISpreadExportRendererInstance of ISpreadExportRenderer class.
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.
public void RunExportAsync(string fileName, ISpreadExportRenderer exportRenderer, string sheetName)The file name where data will be exported.
exportRendererISpreadExportRendererInstance of ISpreadExportRenderer class.
sheetNamestringName of the sheet.
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.
public void RunExportAsync(string fileName, ISpreadExportRenderer exportRenderer)The file name where data will be exported.
exportRendererISpreadExportRendererInstance of ISpreadExportRenderer 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 for every cell that is being exported.
public event ListViewSpreadExportCellFormattingEventHandler CellFormattingOccurs when the export process completes.
public event EventHandler ExportCompleted