PropertyGridSpreadExport is a powerful exporting API, allowing to export RadPropertyGrid 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 PropertyGridSpreadExportInheritance: objectPropertyGridSpreadExport
Constructors
Initializes a new instance of the PropertyGridSpreadExport class.
public PropertyGridSpreadExport(RadPropertyGrid radPropertyGrid, SpreadExportFormat exportFormat)The RadPropertyGrid to export.
exportFormatSpreadExportFormatThe export format.
Initializes a new instance of the PropertyGridSpreadExport class.
public PropertyGridSpreadExport(RadPropertyGrid radPropertyGrid)The RadPropertyGrid 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 child items grouped.
public bool ExportChildItemsGrouped { get; set; }Gets or sets a value indicating whether to export item descriptions.
public bool ExportDescriptions { 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 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 indent of child items.
public int ItemIndent { get; set; }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()Converts an image to the byte representation returned by ImageConverter.
Writes the cell's content and, when enabled, its formatting into the specified worksheet position.
protected virtual void CreateCell(PropertyGridSpreadExportCell cell, int currentRowIndex, int currentColumnIndex)The cell whose content and formatting are exported.
currentRowIndexintThe zero-based worksheet row index.
currentColumnIndexintThe zero-based worksheet column index.
Copies the border style and colors from a visual cell into export-cell data.
protected virtual void GetBordersFromVisualCell(PropertyGridSpreadExportCell cell, LightVisualElement visualCell)The export cell that receives the border settings.
visualCellLightVisualElementThe visual cell whose border settings are copied.
Copies font, text alignment, wrapping, and colors from a visual cell into export-cell data.
protected virtual void GetStylesFromVisualCell(PropertyGridSpreadExportCell 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(PropertyGridSpreadExportCellFormattingEventArgs e)The PropertyGridSpreadExportCellFormattingEventArgs 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, 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 RadPropertyGrid 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 RadPropertyGrid 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 RadPropertyGrid 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 RadPropertyGrid 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 PropertyGridSpreadExportCellFormattingEventHandler CellFormattingOccurs when the export process completes.
public event EventHandler ExportCompleted