Class ExportPivotGridToExcel

Represents a class that transfers the grid content to excel document.

Inheritance

System.Object

ExportPivotGridToExcel

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.PivotGridConverter

Assembly: Syncfusion.SfPivotGridConverter.UWP.dll

Syntax

public class ExportPivotGridToExcel : Object, IDisposable

Constructors

ExportPivotGridToExcel(PivotEngine, ExportingGridStyleInfo, GridLayout, String, Boolean)

Initializes a new instance of the ExportPivotGridToExcel class.

Declaration

public ExportPivotGridToExcel(PivotEngine pivotData, ExportingGridStyleInfo gridStyleInfo, GridLayout layout, string excelExtension, bool isItemsSource)

Parameters

Type	Name	Description
PivotEngine	pivotData	The pivot data.
ExportingGridStyleInfo	gridStyleInfo	The grid style information.
GridLayout	layout	The grid layout.
System.String	excelExtension	The extension to save as excel document.
System.Boolean	isItemsSource	Indicates whether it is items source.

ExportPivotGridToExcel(PivotEngine, ExportingGridStyleInfo, GridLayout, String, Boolean, ObservableCollection<PivotGridDataConditionalFormat>)

Initializes a new instance of the ExportPivotGridToExcel class.

Declaration

public ExportPivotGridToExcel(PivotEngine pivotData, ExportingGridStyleInfo gridStyleInfo, GridLayout layout, string excelExtension, bool isItemsSource, ObservableCollection<PivotGridDataConditionalFormat> conditionalFormat)

Parameters

Type	Name	Description
PivotEngine	pivotData	The pivot data.
ExportingGridStyleInfo	gridStyleInfo	The grid style information.
GridLayout	layout	The grid layout.
System.String	excelExtension	The extension to save as excel document.
System.Boolean	isItemsSource	Indicates whether it is items source.
System.Collections.ObjectModel.ObservableCollection<PivotGridDataConditionalFormat>	conditionalFormat	The conditional format.

ExportPivotGridToExcel(PivotEngine[], ExportingGridStyleInfo, GridLayout, String, Boolean)

Initializes a new instance of the ExportPivotGridToExcel class.

Declaration

public ExportPivotGridToExcel(PivotEngine[] pivotData, ExportingGridStyleInfo gridStyleInfo, GridLayout layout, string excelExtension, bool isItemsSource)

Parameters

Type	Name	Description
PivotEngine[]	pivotData	The pivot data.
ExportingGridStyleInfo	gridStyleInfo	The grid style information.
GridLayout	layout	The grid layout.
System.String	excelExtension	The extension to save as excel document.
System.Boolean	isItemsSource	Indicates whether it is items source.

Exceptions

Type	Condition
System.ArgumentNullException	Throws exception if the PivotEngine array is null or its length become zero.

ExportPivotGridToExcel(PivotEngine[], ExportingGridStyleInfo, GridLayout, String, Boolean, ObservableCollection<PivotGridDataConditionalFormat>)

Initializes a new instance of the ExportPivotGridToExcel class.

Declaration

public ExportPivotGridToExcel(PivotEngine[] pivotData, ExportingGridStyleInfo gridStyleInfo, GridLayout layout, string excelExtension, bool isItemsSource, ObservableCollection<PivotGridDataConditionalFormat> conditionalFormat)

Parameters

Type	Name	Description
PivotEngine[]	pivotData	The pivot data.
ExportingGridStyleInfo	gridStyleInfo	The grid style information.
GridLayout	layout	The grid layout.
System.String	excelExtension	The extension to save as excel document.
System.Boolean	isItemsSource	Indicates whether it is items source.
System.Collections.ObjectModel.ObservableCollection<PivotGridDataConditionalFormat>	conditionalFormat	The Conditional format.

Exceptions

Type	Condition
System.ArgumentNullException	Throws exception if the PivotEngine array is null or its length become zero.

ExportPivotGridToExcel(SfPivotGrid, ExportingGridStyleInfo, String, Boolean)

Initializes a new instance of the ExportPivotGridToExcel class.

Declaration

public ExportPivotGridToExcel(SfPivotGrid pivotGrid, ExportingGridStyleInfo gridStyleInfo, string excelExtension, bool isItemsSource)

Parameters

Type	Name	Description
SfPivotGrid	pivotGrid	This parameter holds the SfPivotGrid control object which is utilized for Excel exporting.
ExportingGridStyleInfo	gridStyleInfo	The grid style information.
System.String	excelExtension	The extension to save as excel document.
System.Boolean	isItemsSource	Indicates whether it is items source.

Remarks

This is applicable only for relational data source.

ExportPivotGridToExcel(SfPivotGrid[], ExportingGridStyleInfo, String, Boolean)

Initializes a new instance of the ExportPivotGridToExcel class.

Declaration

public ExportPivotGridToExcel(SfPivotGrid[] pivotGrid, ExportingGridStyleInfo gridStyleInfo, string excelExtension, bool isItemsSource)

Parameters

Type	Name	Description
SfPivotGrid[]	pivotGrid	This parameter holds the SfPivotGrid control object which is utilized for Excel exporting.
ExportingGridStyleInfo	gridStyleInfo	The grid style information.
System.String	excelExtension	The extension to save as excel document.
System.Boolean	isItemsSource	Indicates whether it is items source.

Exceptions

Type	Condition
System.ArgumentNullException	Throws exception if the SfPivotGrid control is null or its length become zero.

Properties

ExportMode

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

Declaration

public ExportModes ExportMode { get; set; }

Property Value

Type	Description
ExportModes	ExportMode

Methods

add_Exporting(ExportingGridEventHandler)

Declaration

public void add_Exporting(ExportingGridEventHandler value)

Parameters

Type	Name	Description
ExportingGridEventHandler	value

Dispose()

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

Declaration

public void Dispose()

ExportToDocument(String)

Exports the grid to excel document.

Declaration

public void ExportToDocument(string fileName)

Parameters

Type	Name	Description
System.String	fileName	The file name for exported excel document.

remove_Exporting(ExportingGridEventHandler)

Declaration

public void remove_Exporting(ExportingGridEventHandler value)

Parameters

Type	Name	Description
ExportingGridEventHandler	value

Events

Exporting

Occurs while exporting the document.

Declaration

public event ExportingGridEventHandler Exporting

Event Type

Type
ExportingGridEventHandler

Implements

System.IDisposable

Extension Methods

DateTimeExtension.ToDateTime(Object)