Class ExportPivotGridToWord

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

Inheritance
System.Object
ExportPivotGridToWord
Namespace: Syncfusion.UI.Xaml.PivotGridConverter
Assembly: Syncfusion.SfPivotGridConverter.UWP.dll
Syntax
public class ExportPivotGridToWord : Object

Constructors

ExportPivotGridToWord(PivotEngine, GridLayout, ExportingGridStyleInfo)

Initializes a new instance of the ExportPivotGridToWord class.

Declaration
public ExportPivotGridToWord(PivotEngine pivotData, GridLayout layout, ExportingGridStyleInfo gridStyleInfo)
Parameters
Type Name Description
PivotEngine pivotData

The pivot data.
GridLayout layout

The grid layout.
ExportingGridStyleInfo gridStyleInfo

The grid style information.

ExportPivotGridToWord(PivotEngine, GridLayout, ExportingGridStyleInfo, ObservableCollection<PivotGridDataConditionalFormat>)

Initializes a new instance of the ExportPivotGridToWord class.

Declaration
public ExportPivotGridToWord(PivotEngine pivotData, GridLayout layout, ExportingGridStyleInfo gridStyleInfo, ObservableCollection<PivotGridDataConditionalFormat> conditionalFormat)
Parameters
Type Name Description
PivotEngine pivotData

The pivot data.
GridLayout layout

The grid layout.
ExportingGridStyleInfo gridStyleInfo

The grid style information.
System.Collections.ObjectModel.ObservableCollection<PivotGridDataConditionalFormat> conditionalFormat

The Conditional format.

ExportPivotGridToWord(PivotEngine[], GridLayout, ExportingGridStyleInfo)

Initializes a new instance of the ExportPivotGridToWord class.

Declaration
public ExportPivotGridToWord(PivotEngine[] pivotData, GridLayout layout, ExportingGridStyleInfo gridStyleInfo)
Parameters
Type Name Description
PivotEngine[] pivotData

The pivot data.
GridLayout layout

The grid layout.
ExportingGridStyleInfo gridStyleInfo

The grid style information.
Exceptions
Type Condition
System.ArgumentNullException

Throws exception if the PivotEngine array is null or its length become zero.

ExportPivotGridToWord(PivotEngine[], GridLayout, ExportingGridStyleInfo, ObservableCollection<PivotGridDataConditionalFormat>)

Initializes a new instance of the ExportPivotGridToWord class.

Declaration
public ExportPivotGridToWord(PivotEngine[] pivotData, GridLayout layout, ExportingGridStyleInfo gridStyleInfo, ObservableCollection<PivotGridDataConditionalFormat> conditionalFormat)
Parameters
Type Name Description
PivotEngine[] pivotData

The pivot data.
GridLayout layout

The grid layout.
ExportingGridStyleInfo gridStyleInfo

The grid style information.
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.

ExportPivotGridToWord(SfPivotGrid, ExportingGridStyleInfo)

Initializes a new instance of the ExportPivotGridToWord class.

Declaration
public ExportPivotGridToWord(SfPivotGrid pivotGrid, ExportingGridStyleInfo gridStyleInfo)
Parameters
Type Name Description
SfPivotGrid pivotGrid

This parameter holds the SfPivotGrid control object which is utilized for Word exporting.
ExportingGridStyleInfo gridStyleInfo

The grid style information.
Remarks

This is applicable only for relational data source.

ExportPivotGridToWord(SfPivotGrid[], ExportingGridStyleInfo)

Initializes a new instance of the ExportPivotGridToWord class.

Declaration
public ExportPivotGridToWord(SfPivotGrid[] pivotGrid, ExportingGridStyleInfo gridStyleInfo)
Parameters
Type Name Description
SfPivotGrid[] pivotGrid

This parameter holds the SfPivotGrid control object which is utilized for Word exporting.
ExportingGridStyleInfo gridStyleInfo

The grid style information.
Exceptions
Type Condition
System.ArgumentNullException

Throws exception if the SfPivotGrid control is null or its length become zero.

Methods

add_Exporting(ExportingGridEventHandler)

Declaration
public void add_Exporting(ExportingGridEventHandler value)
Parameters
Type Name Description
ExportingGridEventHandler value

ExportToDocument(String)

Exports the grid to word document.

Declaration
public void ExportToDocument(string fileName)
Parameters
Type Name Description
System.String fileName

The file name for exported word 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

Extension Methods