Class PivotGridSerializer

This class is used to serialize some important properties in PivotGrid control.

Inheritance

System.Object

PivotGridSerializer

Namespace: Syncfusion.Windows.Controls.PivotGrid

Assembly: Syncfusion.PivotAnalysis.WPF.dll

Syntax

public class PivotGridSerializer : Object

Constructors

PivotGridSerializer()

Initializes a new instance of the PivotGridSerializer class.

Declaration

public PivotGridSerializer()

PivotGridSerializer(PivotGridControl)

Initializes a new instance of the PivotGridSerializer class.

Declaration

public PivotGridSerializer(PivotGridControl ctrl)

Parameters

Type	Name	Description
PivotGridControl	ctrl	The PivotGrid control.

Properties

AllowResizeColumns

Gets or sets a value indicating whether to allow re-size columns.

Declaration

public bool AllowResizeColumns { get; set; }

Property Value

Type	Description
System.Boolean	Returns true if allow re-size columns; otherwise, false.

AllowResizeRows

Gets or sets a value indicating whether to allow re-size rows.

Declaration

public bool AllowResizeRows { get; set; }

Property Value

Type	Description
System.Boolean	Returns true if allow re-size rows; otherwise, false.

AllowSelection

Gets or sets a value indicating whether to allow cell selection like-in Excel.

Declaration

public bool AllowSelection { get; set; }

Property Value

Type	Description
System.Boolean	Returns true if [allow selection]; otherwise, false.

AllowSelectionWithHeaders

Gets or sets a value indicating whether to allow cell selection with headers like-in Excel.

Declaration

public bool AllowSelectionWithHeaders { get; set; }

Property Value

Type	Description
System.Boolean	Returns true if [allow selection with headers]; otherwise, false.

AutoSizeColumnCount

Gets or sets the value indicating the number of columns to be re-sized.

Declaration

public int AutoSizeColumnCount { get; set; }

Property Value

Type
System.Int32

AutoSizeOption

Gets or sets the auto size option based on which Grid rows will be re-sized.

Declaration

public GridAutoSizeOption AutoSizeOption { get; set; }

Property Value

Type	Description
GridAutoSizeOption	The auto size option.

AutoSizeRowCount

Gets or sets the value indicating the number of rows to be re-sized.

Declaration

public int AutoSizeRowCount { get; set; }

Property Value

Type
System.Int32

ConditionalFormats

Gets or sets the list of conditional formats.

Declaration

public List<PivotGridDataConditionalFormat> ConditionalFormats { get; set; }

Property Value

Type
System.Collections.Generic.List<PivotGridDataConditionalFormat>

DeferLayoutUpdate

Gets or sets a value indicating whether the layout should be updated immediately after the pivoting information update or it should wait for a refresh call.

Declaration

public bool DeferLayoutUpdate { get; set; }

Property Value

Type
System.Boolean

Filters

Gets or sets the filter expressions.

Declaration

public ObservableCollection<FilterExpression> Filters { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<FilterExpression>

Format

Gets or sets the format of filter item.

Declaration

public string Format { get; set; }

Property Value

Type
System.String

FreezeHeaders

Gets or sets a value indicating whether the row and column headers should freeze or not.

Declaration

public bool FreezeHeaders { get; set; }

Property Value

Type
System.Boolean

GridControl

Gets or sets the PivotGrid control.

Declaration

public PivotGridControl GridControl { get; set; }

Property Value

Type
PivotGridControl

GridFilterCollection

Gets or sets the filter collection of PivotGrid.

Declaration

public List<GridFilter> GridFilterCollection { get; set; }

Property Value

Type
System.Collections.Generic.List<GridFilter>

GridLayout

Gets or sets the layout for the Pivot control.

Declaration

public GridLayout GridLayout { get; set; }

Property Value

Type
GridLayout

GridSortCollection

Gets or sets the sort collection of PivotGrid.

Declaration

public List<Sort> GridSortCollection { get; set; }

Property Value

Type
System.Collections.Generic.List<Sort>

GroupingBarFiltering

Gets or sets a value indicating whether filtering needs to enabled in GroupingBar.

Declaration

public bool GroupingBarFiltering { get; set; }

Property Value

Type
System.Boolean

GroupingBarSorting

Gets or sets a value indicating whether sorting needs to enabled in GroupingBar.

Declaration

public bool GroupingBarSorting { get; set; }

Property Value

Type
System.Boolean

HiddenColumnGroups

Gets or sets the list of hidden columns.

Declaration

public List<HiddenGroup> HiddenColumnGroups { get; set; }

Property Value

Type
System.Collections.Generic.List<HiddenGroup>

HiddenRowGroups

Gets or sets the list of hidden rows.

Declaration

public List<HiddenGroup> HiddenRowGroups { get; set; }

Property Value

Type
System.Collections.Generic.List<HiddenGroup>

IgnoreExpandCollapseOnSerialization

Gets or sets a value indicating whether to ignore expand/collapse state of cells on serialization.

Declaration

public bool IgnoreExpandCollapseOnSerialization { get; set; }

Property Value

Type	Description
System.Boolean	Returns true if [ignore expand collapse on serialization]; otherwise, false.

IsDynamicData

Gets or sets a value indicating whether the supplied ItemSource is dynamic.

Declaration

public bool IsDynamicData { get; set; }

Property Value

Type
System.Boolean

PivotCalculations

Gets or sets the PivotCalculations.

Declaration

public ObservableCollection<PivotComputationInfo> PivotCalculations { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<PivotComputationInfo>

PivotColumns

Gets or sets the column based PivotItems.

Declaration

public ObservableCollection<PivotItem> PivotColumns { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<PivotItem>

PivotFields

Gets or sets the PivotFields.

Declaration

public ObservableCollection<PivotItem> PivotFields { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<PivotItem>

PivotRows

Gets or sets the row based PivotItems..

Declaration

public ObservableCollection<PivotItem> PivotRows { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<PivotItem>

ResizePivotGridToFit

Gets or sets a value indicating whether the PivotGrid re-size to its changed size.

Declaration

public bool ResizePivotGridToFit { get; set; }

Property Value

Type
System.Boolean

ShowCalculationsAsColumns

Gets or sets a value indicating whether the calculations should appear as rows or columns. By default, calculations appear as columns.

Declaration

public bool ShowCalculationsAsColumns { get; set; }

Property Value

Type
System.Boolean

ShowDisabledGroupBackground

Enable/disable the PivotItems in grouping fields. Default value is false.

Declaration

public bool ShowDisabledGroupBackground { get; set; }

Property Value

Type	Description
System.Boolean	The selected items.

ShowEmptyCells

Gets or sets a value indicating whether to show empty value cell if summary value has null value. By default, the value is true.

Declaration

public bool ShowEmptyCells { get; set; }

Property Value

Type
System.Boolean

ShowFieldList

Gets or sets a value indicating whether FieldList needs to be visible or not.

Declaration

public bool ShowFieldList { get; set; }

Property Value

Type
System.Boolean

ShowGrandTotals

Gets or sets a value indicating whether the grand total calculations should be computed by the Engine.

Declaration

public bool ShowGrandTotals { get; set; }

Property Value

Type
System.Boolean

Remarks

The default value is true.

ShowGroupingBar

Gets or sets a value indicating whether GroupingBar needs to be visible or not.

Declaration

public bool ShowGroupingBar { get; set; }

Property Value

Type
System.Boolean

ShowSubTotals

Gets or sets a value indicating whether sub-total calculations should be shown or hidden.

Declaration

public bool ShowSubTotals { get; set; }

Property Value

Type
System.Boolean

Remarks

The default value is true.

StatePersistenceEnabled

Gets or sets a value indicating whether to maintain/show collapsed cells when PivotSchema getting changed.

Declaration

public bool StatePersistenceEnabled { get; set; }

Property Value

Type
System.Boolean

VisualStyle

Gets or sets the theme of the control.

Declaration

public PivotGridVisualStyle VisualStyle { get; set; }

Property Value

Type
PivotGridVisualStyle

Methods

ConfigureColumnHeaderArea(PivotGridControl)

Method used to configure the column header area data while serialize the PivotGrid to XML.

Declaration

public void ConfigureColumnHeaderArea(PivotGridControl ctrl)

Parameters

Type	Name	Description
PivotGridControl	ctrl	The PivotGrid control.

ConfigureFilter(PivotGridControl)

Method used to configure filter in PivotGrid control while serializing it to XML.

Declaration

public void ConfigureFilter(PivotGridControl ctrl)

Parameters

Type	Name	Description
PivotGridControl	ctrl	The PivotGrid control.