Class PivotGridSpreadExport

Inheritance
System.Object
PivotGridSpreadExport
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.PivotGrid.dll

Syntax

public class PivotGridSpreadExport

Constructors

PivotGridSpreadExport(RadPivotGrid)

Declaration
public PivotGridSpreadExport(RadPivotGrid pivotGrid)
Parameters
RadPivotGrid pivotGrid

PivotGridSpreadExport(RadPivotGridElement)

Declaration
public PivotGridSpreadExport(RadPivotGridElement pivotGrid)
Parameters
RadPivotGridElement pivotGrid

Properties

BorderColor

Gets or sets the color of grid borders.

Declaration
public Color BorderColor { get; set; }
Property Value
System.Drawing.Color

CellBackColor

Gets or sets the background color of cells.

Declaration
public Color CellBackColor { get; set; }
Property Value
System.Drawing.Color

ColumnsLayoutType

Gets the layout type of pivot grid column container.

Declaration
public PivotLayout ColumnsLayoutType { get; set; }
Property Value
PivotLayout

DataCellsFont

Gets or sets the font of data cells.

Declaration
public Font DataCellsFont { get; set; }
Property Value
System.Drawing.Font

DescriptorsBackColor

Gets or sets the background color of descriptor cells.

Declaration
public Color DescriptorsBackColor { get; set; }
Property Value
System.Drawing.Color

ExportFlatData

Gets or sets a value indicating whether to export flat data(collapsed rows and columns).

Declaration
public bool ExportFlatData { 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.

ExportSelectionOnly

Gets or sets a value indicating whether to export only selection.

Declaration
public bool ExportSelectionOnly { 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

GrandTotalsBackColor

Gets or sets the background color of grandtotal cells.

Declaration
public Color GrandTotalsBackColor { get; set; }
Property Value
System.Drawing.Color

HeaderCellsFont

Gets or sets the font of header cells.

Declaration
public Font HeaderCellsFont { get; set; }
Property Value
System.Drawing.Font

HeadersBackColor

Gets or sets the background color of header cells.

Declaration
public Color HeadersBackColor { get; set; }
Property Value
System.Drawing.Color

LayoutType

Gets the layout type of pivot grid row container.

Declaration
public PivotLayout LayoutType { get; }
Property Value
PivotLayout

RowsLayoutType

Gets the layout type of pivot grid row container.

Declaration
public PivotLayout RowsLayoutType { get; set; }
Property Value
PivotLayout

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.

ShowGridLines

Gets or sets a value indicating whether to show grid lines in exported file.

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

SubTotalsBackColor

Gets or sets the background color of subtotal cells.

Declaration
public Color SubTotalsBackColor { get; set; }
Property Value
System.Drawing.Color

Methods

AddRowToWorksheet(PivotGridExportRowElement)

Declaration
[Obsolete("Use AddRowToWorksheet(PivotGridExportRowElement rowElement, int rowIndex) method instead. This method will be removed in R3 2024.")]
protected virtual void AddRowToWorksheet(PivotGridExportRowElement rowElement)
Parameters
PivotGridExportRowElement rowElement

AddRowToWorksheet(PivotGridExportRowElement, Int32)

Declaration
protected virtual void AddRowToWorksheet(PivotGridExportRowElement rowElement, int rowIndex)
Parameters
PivotGridExportRowElement rowElement

System.Int32 rowIndex

CancelExportAsync()

Cancels an asynchronous export operation.

Declaration
public void CancelExportAsync()

GetAggregateDescriptorCell(Int32)

Declaration
protected virtual PivotGridSpreadExportCellElement GetAggregateDescriptorCell(int aggregateIndex)
Parameters
System.Int32 aggregateIndex

Returns
PivotGridSpreadExportCellElement

GetColumnDescriptorCell(Int32)

Declaration
protected virtual PivotGridSpreadExportCellElement GetColumnDescriptorCell(int descriptorIndex)
Parameters
System.Int32 descriptorIndex

Returns
PivotGridSpreadExportCellElement

GetColumnHeaderCell(Int32, Int32)

Declaration
protected virtual PivotGridSpreadExportCellElement GetColumnHeaderCell(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

System.Int32 columnIndex

Returns
PivotGridSpreadExportCellElement

GetDataCell(Int32, Int32, PivotRowElement)

Declaration
protected virtual PivotGridSpreadExportCellElement GetDataCell(int rowIndex, int columnIndex, PivotRowElement visualRow)
Parameters
System.Int32 rowIndex

System.Int32 columnIndex

PivotRowElement visualRow

Returns
PivotGridSpreadExportCellElement

GetDataTypeFromText(String)

Declaration
protected virtual DataType GetDataTypeFromText(string text)
Parameters
System.String text

Returns
DataType

GetExportElementForCell(Int32, Int32, PivotRowElement)

Declaration
protected virtual PivotGridSpreadExportCellElement GetExportElementForCell(int rowIndex, int columnIndex, PivotRowElement visualRow)
Parameters
System.Int32 rowIndex

System.Int32 columnIndex

PivotRowElement visualRow

Returns
PivotGridSpreadExportCellElement

GetRowDescriptorCell(Int32)

Declaration
protected virtual PivotGridSpreadExportCellElement GetRowDescriptorCell(int descriptorIndex)
Parameters
System.Int32 descriptorIndex

Returns
PivotGridSpreadExportCellElement

GetRowHeaderCell(Int32, Int32)

Declaration
protected virtual PivotGridSpreadExportCellElement GetRowHeaderCell(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

System.Int32 columnIndex

Returns
PivotGridSpreadExportCellElement

GetStylesFromVisualCell(PivotGridSpreadExportCellElement, LightVisualElement)

Declaration
protected virtual void GetStylesFromVisualCell(PivotGridSpreadExportCellElement gridVisualElement, LightVisualElement visualCell)
Parameters
PivotGridSpreadExportCellElement gridVisualElement

LightVisualElement visualCell

GetVisualElement(Int32, Int32)

Declaration
protected virtual LightVisualElement GetVisualElement(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

System.Int32 columnIndex

Returns
LightVisualElement

Initialize()

Declaration
public virtual void Initialize()

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(PivotGridSpreadExportCellFormattingEventArgs)

Raises the CellFormatting event.

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

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

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.

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.

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.

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.

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.

ValidateExcelCellValue(String, DataType)

Declaration
protected virtual string ValidateExcelCellValue(string text, DataType dataType)
Parameters
System.String text

DataType dataType

Returns
System.String

WriteCells()

Declaration
protected virtual void WriteCells()

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 PivotGridSpreadExportCellFormattingEventHandler CellFormatting
Event Type
PivotGridSpreadExportCellFormattingEventHandler

ExportCompleted

Occurs when the export process completes.

Declaration
public event EventHandler ExportCompleted
Event Type
System.EventHandler

Extension Methods