Class SerializablePivotGrid

Represents a class that is used to serialize and deserialize SfPivotGrid properties.

Inheritance
System.Object
SerializablePivotGrid
Namespace: Syncfusion.UI.Xaml.PivotGrid
Assembly: Syncfusion.SfPivotGrid.UWP.dll
Syntax
public class SerializablePivotGrid : Object

Constructors

SerializablePivotGrid()

Declaration
public SerializablePivotGrid()

Properties

AllowedFields

Gets a collection of Syncfusion.PivotAnalysis.UWP.FieldInfo objects that hold field names that you want to get visible in the engine. The names can be either public property names of the underlying data objects, or they can be expression field.

Declaration
public List<FieldInfo> AllowedFields { get; set; }
Property Value
Type
System.Collections.Generic.List<FieldInfo>
Remarks

If your data contains fields that you do not want exposed to the pivoting process, then add the names of the properties you want to include to this list. All other fields will be excluded. If you leave this collection empty, the default behavior will be to make all public properties available for use in the PivotTable. To add an expression field, set the FieldInfo.FieldType to FieldsType.Expression and set FieldInfo.Expression to be a string holding a well formed expression defining the value that should appear in this field.

AllowMultiFunctionalSortFilter

Gets or sets whether excel-like filtering in GroupingBar is enabled or not.

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

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.

ColumnHeaderStyle

Gets or sets the style for column header cells.

Declaration
public SerializablePivotGridCellStyle ColumnHeaderStyle { get; set; }
Property Value
Type Description
SerializablePivotGridCellStyle

The row header style.

ConditionalFormats

Gets or sets a value indicating whether to enable or disable conditional format.

Declaration
public ObservableCollection<SerializablePivotGridDataConditionalFormat> ConditionalFormats { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<SerializablePivotGridDataConditionalFormat>

EnableColumnHeaderArea

Gets or sets the value to show/hide column header items.

Declaration
public bool EnableColumnHeaderArea { get; set; }
Property Value
Type Description
System.Boolean

Returns true if [EnableColumnHeaderArea]; otherwise, false.

EnableConditonalFormat

Gets or sets a value indicating whether to enable or disable conditional format.

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

EnableDrillThrough

Gets or sets a value indicating whether to enable DrillThrough or not. ///

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

EnableFilterHeaderArea

Gets or sets the value to show/hide filter header items.

Declaration
public bool EnableFilterHeaderArea { get; set; }
Property Value
Type Description
System.Boolean

Returns true if [EnableFilterHeaderArea]; otherwise, false.

EnableGroupingBarFiltering

Gets or sets a value indicating whether the filtering is enabled in grouping bar.

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

EnableGroupingBarRemoving

Gets or sets the value to indicate the grouping bar removing is enabled or not.

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

EnableGroupingBarSorting

Gets or sets the value to indicate the grouping bar sorting is enabled or not.

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

EnableHyperlinkOnMouseOver

Gets or sets whether to enable hyperlink only while hovering the cell and disables on leaving it. The default value is false. This property has an effect only if "RowPivotsOnly" is set to true.

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

EnableRowHeaderArea

Gets or sets the value to show/hide row header items.

Declaration
public bool EnableRowHeaderArea { get; set; }
Property Value
Type Description
System.Boolean

Returns true if [EnableRowHeaderArea]; otherwise, false.

EnableStatePersistence

Gets or sets a value indicating whether to maintain the state of collapsed cells when pivot grid is refreshed.

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

EnableUpdating

Gets or sets a value to enable updating of PivotValues.

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

EnableValueEditing

Gets or sets a value indication whether to edit the value cells or not.

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

EnableValueHeaderArea

Gets or sets the value to show/hide value header items.

Declaration
public bool EnableValueHeaderArea { get; set; }
Property Value
Type Description
System.Boolean

Returns true if [EnableValueHeaderArea]; otherwise, false.

Filters

Gets or sets the collection of filter expressions.

Declaration
public ObservableCollection<FilterExpression> Filters { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<FilterExpression>

FlowDirection

Gets or sets flow direction of the Pivot Grid control.

Declaration
public FlowDirection FlowDirection { get; set; }
Property Value
Type
Windows.UI.Xaml.FlowDirection

FreezeHeaders

Gets or sets the value to indicate the headers are needs to be freezes or not.

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

GridFilterCollection

Gets or sets the filter collection of SfPivotGrid.

Declaration
public List<SerializableFilterItem> GridFilterCollection { get; set; }
Property Value
Type
System.Collections.Generic.List<SerializableFilterItem>

GridLayout

Gets or sets the grid layout of SfPivotGrid control.

Declaration
public GridLayout GridLayout { get; set; }
Property Value
Type
GridLayout

GridSortCollection

Gets or sets the sort collection of PivotGrid.

Declaration
public List<SerializableSortItem> GridSortCollection { get; set; }
Property Value
Type
System.Collections.Generic.List<SerializableSortItem>

GridVisualStyle

Gets or sets the different kinds of visual style for Pivot Grid control.

Declaration
public PivotGridVisualStyle GridVisualStyle { get; set; }
Property Value
Type
PivotGridVisualStyle

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.

LabelFilterApplied

Gets or sets the value indicating whether the label filter is applied or not.

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

LoadInBackground

Gets or sets the value to indicate the load in background is enabled or not.

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

PivotCalculations

Gets or sets the collection of PivotCalculations.

Declaration
public ObservableCollection<PivotComputationInfo> PivotCalculations { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<PivotComputationInfo>

PivotColumns

Gets or sets the collection of PivotItems of PivotColumns.

Declaration
public ObservableCollection<PivotItem> PivotColumns { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<PivotItem>

PivotRows

Gets or sets the collection of PivotItems of PivotRows.

Declaration
public ObservableCollection<PivotItem> PivotRows { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<PivotItem>

ResizeColumnsToFit

Gets or sets a value indicating whether to resize the columns to fit the grid based on values or not.

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

ResizeRowsToFit

Gets or sets a value indicating whether to resize the rows to fit the grid based on values or not.

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

RowHeaderStyle

Gets or sets the style for row header cells.

Declaration
public SerializablePivotGridCellStyle RowHeaderStyle { get; set; }
Property Value
Type Description
SerializablePivotGridCellStyle

The row header style.

RowPivotsOnly

Gets or sets value indicating whether to PivotTable contains only rows and calculations.

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

ShowCalculationsAsColumns

Gets or sets whether the calculations should appear as rows/columns in the PivotGrid. By default the calculations is displayed as columns.

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

ShowColumnSubTotals

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

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

ShowGroupingBar

Gets or sets a value indicating whether the grouping bar is shown.

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

ShowHeaderCellsToolTip

Gets or sets a value indicating whether to show or hide the tool tip for header cells.

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

ShowPivotValueChooser

Gets or sets the visibility of pivot value chooser window.

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

ShowRowSubTotals

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

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

ShowSubTotals

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

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

ShowValueCellToolTip

Gets or sets a value indicating whether to show or hide the tool tip for value cells.

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

SortOption

Gets or sets the option for sorting for value columns in PivotGrid control

Declaration
public SortOptions SortOption { get; set; }
Property Value
Type
SortOptions

SummaryColumnStyle

Gets or sets the style for summary column cells.

Declaration
public SerializablePivotGridCellStyle SummaryColumnStyle { get; set; }
Property Value
Type Description
SerializablePivotGridCellStyle

The row header style.

SummaryRowStyle

Gets or sets the style for summary row cells.

Declaration
public SerializablePivotGridCellStyle SummaryRowStyle { get; set; }
Property Value
Type Description
SerializablePivotGridCellStyle

The row header style.

ValueCellStyle

Gets or sets the style for value cells.

Declaration
public SerializablePivotGridCellStyle ValueCellStyle { get; set; }
Property Value
Type Description
SerializablePivotGridCellStyle

The row header style.

ValueFilterApplied

Gets or sets the value indicating whether the value filter is applied or not.

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

Extension Methods