Class ExcelExport

Represents the class used to export the pivot control to excel document.

Inheritance

System.Object

ExcelExport

Implements

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.PivotConverter

Assembly: Syncfusion.PivotConverter.Windows.dll

Syntax

public class ExcelExport : IDisposable

Constructors

ExcelExport(PivotGridControl)

Initializes a new instance of the ExcelExport class.

Declaration

public ExcelExport(PivotGridControl gridControl)

Parameters

Type	Name	Description
PivotGridControl	gridControl	The PivotGridControl that is to be exported.

ExcelExport(PivotGridControl, ExportModes)

Initializes a new instance of the ExcelExport class.

Declaration

public ExcelExport(PivotGridControl gridControl, ExportModes mode)

Parameters

Type	Name	Description
PivotGridControl	gridControl	The PivotGridControl that is to be exported.
ExportModes	mode	The exporting mode.

ExcelExport(PivotGridControl, ExcelVersion)

Initializes a new instance of the ExcelExport class.

Declaration

public ExcelExport(PivotGridControl gridControl, ExcelVersion version)

Parameters

Type	Name	Description
PivotGridControl	gridControl	The PivotGridControl that is to be exported.
ExcelVersion	version	The excel version to export the pivot grid. Accessible through adding Syncfusion.XlsIO.Base as project reference.

ExcelExport(PivotGridControl, ExcelVersion, ExportModes)

Initializes a new instance of the ExcelExport class.

Declaration

public ExcelExport(PivotGridControl gridControl, ExcelVersion version, ExportModes mode)

Parameters

Type	Name	Description
PivotGridControl	gridControl	The PivotGridControl that is to be exported.
ExcelVersion	version	The excel version to export the pivot grid. Accessible through adding Syncfusion.XlsIO.Base as project reference.
ExportModes	mode	The exporting mode.

ExcelExport(PivotGridControl[], ExcelVersion, ExportModes)

Initializes a new instance of the ExcelExport class.

Declaration

public ExcelExport(PivotGridControl[] gridControl, ExcelVersion version, ExportModes mode)

Parameters

Type	Name	Description
PivotGridControl[]	gridControl	The PivotGridControl that is to be exported.
ExcelVersion	version	The excel version to export the pivot grid. Accessible through adding Syncfusion.XlsIO.Base as project reference.
ExportModes	mode	The exporting Mode

ExcelExport(PivotChart, ExcelVersion, ExcelChartType)

Initializes a new instance of the ExcelExport class.

Declaration

public ExcelExport(PivotChart pivotChart, ExcelVersion version, ExcelChartType excelChartType)

Parameters

Type	Name	Description
PivotChart	pivotChart	The PivotChart that is to be exported.
ExcelVersion	version	The excel version to export the pivot grid. Accessible through adding Syncfusion.XlsIO.Base as project reference.
ExcelChartType	excelChartType	The excel chart type.

Properties

application

Gets or sets the IApplication to instantiate various kinds of applications.

Declaration

public IApplication application { get; set; }

Property Value

Type
IApplication

excelEngine

Gets or sets the engine used to export the control to excel.

Declaration

public ExcelEngine excelEngine { get; set; }

Property Value

Type
ExcelEngine

ExportMode

Gets or sets the export mode(Cell/PivotTable) to export.

Declaration

public ExportModes ExportMode { get; set; }

Property Value

Type	Description
ExportModes	The export mode.

gridcontrol1

Gets the PivotGridControl associated with the exporting.

Declaration

public PivotGridControl gridcontrol1 { get; }

Property Value

Type	Description
PivotGridControl	The PivotGridControl associated with the exporting.

sheet

Gets or sets the worksheet to be added in workbook .

Declaration

public IWorksheet sheet { get; set; }

Property Value

Type
IWorksheet

workBook

Gets or sets the workbook to be added in excel document.

Declaration

public IWorkbook workBook { get; set; }

Property Value

Type
IWorkbook

Methods

ApplyNumberFormat(Object, IPivotField)

Applies the number format to pivot fields.

Declaration

public static void ApplyNumberFormat(object item, IPivotField field)

Parameters

Type	Name	Description
System.Object	item	The pivot item or pivot computation information.
IPivotField	field	The IPivotField that contains number format.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Export(String)

Exports the pivot control to excel document with the specified file name.

Declaration

public void Export(string fileName)

Parameters

Type	Name	Description
System.String	fileName	The name of the excel document.

Implements

System.IDisposable