Class SfPivotGrid

Summarizes a large amount of information and represents it in a cross-tabulated form.

Inheritance
System.Object
SfPivotGrid
Implements
System.IDisposable
Namespace: Syncfusion.UI.Xaml.PivotGrid
Assembly: Syncfusion.SfPivotGrid.UWP.dll
Syntax
public class SfPivotGrid : Control, IDisposable

Constructors

SfPivotGrid()

Initializes a new instance of the SfPivotGrid class.

Declaration
public SfPivotGrid()

Fields

AllowMultiFunctionalSortFilterProperty

Identifies the AllowMultiFunctionalSortFilter dependency property.

Declaration
public static DependencyProperty AllowMultiFunctionalSortFilterProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

AllowResizeColumnsProperty

Identifies the AllowResizeColumns dependency property.

Declaration
public static DependencyProperty AllowResizeColumnsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

AllowResizeRowsProperty

Identifies the AllowResizeRows dependency property.

Declaration
public static DependencyProperty AllowResizeRowsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

AllowSelectionProperty

Identifies the AllowSelection dependency property.

Declaration
public static DependencyProperty AllowSelectionProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

AllowSelectionWithHeadersProperty

Identifies the AllowSelectionWithHeaders dependency property.

Declaration
public static DependencyProperty AllowSelectionWithHeadersProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ColumnHeaderStyleProperty

Identifies the ColumnHeaderStyle dependency property.

Declaration
public static DependencyProperty ColumnHeaderStyleProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ConditionalFormatsProperty

Identifies the ConditionalFormats dependency property.

Declaration
public static DependencyProperty ConditionalFormatsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableAutoExecuteProperty

Identifies the EnableAutoExecute dependency property.

Declaration
public static DependencyProperty EnableAutoExecuteProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableColumnHeaderAreaProperty

Identifies the EnableColumnHeaderArea dependency property.

Declaration
public static DependencyProperty EnableColumnHeaderAreaProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableConditionalFormatProperty

Identifies the EnableConditionalFormat dependency property.

Declaration
public static DependencyProperty EnableConditionalFormatProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableDrillThroughProperty

The identifier for the EnableDrillThrough dependency property.

Declaration
public static DependencyProperty EnableDrillThroughProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableFilterHeaderAreaProperty

Identifies the EnableFilterHeaderArea dependency property.

Declaration
public static DependencyProperty EnableFilterHeaderAreaProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableGroupingBarFilteringProperty

Identifies the EnableGroupingBarFiltering dependency property.

Declaration
public static DependencyProperty EnableGroupingBarFilteringProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableGroupingBarRemovingProperty

Identifies the EnableGroupingBarRemoving dependency property.

Declaration
public static DependencyProperty EnableGroupingBarRemovingProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableGroupingBarSortingProperty

Identifies the EnableGroupingBarSorting dependency property.

Declaration
public static DependencyProperty EnableGroupingBarSortingProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableHyperlinkOnMouseOverProperty

Identifies the EnableHyperlinkOnMouseOver dependency property.

Declaration
public static DependencyProperty EnableHyperlinkOnMouseOverProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableRowHeaderAreaProperty

Identifies the EnableRowHeaderArea dependency property.

Declaration
public static DependencyProperty EnableRowHeaderAreaProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableStatePersistenceProperty

Identifies the  dependency property.

Declaration
public static DependencyProperty EnableStatePersistenceProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableUpdatingProperty

Identifies the EnableUpdating dependency property.

Declaration
public static DependencyProperty EnableUpdatingProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

The identifier for the EnableUpdating dependency property.

EnableValueEditingProperty

Identifies the EnableValueEditing dependency property.

Declaration
public static DependencyProperty EnableValueEditingProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

The identifier for the EnableValueEditing dependency property.

EnableValueHeaderAreaProperty

Identifies the EnableValueHeaderArea dependency property.

Declaration
public static DependencyProperty EnableValueHeaderAreaProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ExpanderStyleProperty

Identifies the ExpanderStyle dependency property.

Declaration
public static DependencyProperty ExpanderStyleProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

FieldListBorderBrushProperty

Identifies the FieldListBorderBrush dependency property.

Declaration
public static DependencyProperty FieldListBorderBrushProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

FiltersProperty

Identifies the Filters dependency property.

Declaration
public static DependencyProperty FiltersProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

FreezeHeadersProperty

Identifies the FreezeHeaders dependency property.

Declaration
public static DependencyProperty FreezeHeadersProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

GridLayoutProperty

Identifies the Layout dependency property.

Declaration
public static DependencyProperty GridLayoutProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

GridLineStrokeProperty

Identifies the GridLineStroke dependency property.

Declaration
public static DependencyProperty GridLineStrokeProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

GridLineThicknessProperty

Identifies the GridLineThickness dependency property.

Declaration
public static DependencyProperty GridLineThicknessProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

GridStyleInfoProperty

Identifies the GridStyleInfo dependency property.

Declaration
public static DependencyProperty GridStyleInfoProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

GridVisualStyleProperty

Identifies the GridVisualStyle dependency property.

Declaration
public static DependencyProperty GridVisualStyleProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

GroupingBarBackgroundProperty

Identifies the GroupingBarBackground dependency property.

Declaration
public static DependencyProperty GroupingBarBackgroundProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

GroupingBarBorderBrushProperty

Identifies the GroupingBarBorderBrush dependency property.

Declaration
public static DependencyProperty GroupingBarBorderBrushProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

GroupingBarItemBackgroundProperty

Identifies the GroupingBarItemBackground dependency property.

Declaration
public static DependencyProperty GroupingBarItemBackgroundProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

GroupingBarItemBorderBrushProperty

Identifies the GroupingBarItemBorderBrush dependency property.

Declaration
public static DependencyProperty GroupingBarItemBorderBrushProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

GroupingBarItemForegroundProperty

Identifies the GroupingBarItemForeground dependency property.

Declaration
public static DependencyProperty GroupingBarItemForegroundProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ItemSourceProperty

Identifies the ItemSource dependency property.

Declaration
public static DependencyProperty ItemSourceProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

LayoutProperty

Identifies the Layout dependency property.

Declaration
public static DependencyProperty LayoutProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

LoadInBackgroundProperty

Identifies the Syncfusion.UI.Xaml.Controls.PivotGrid.LoadInBackground dependency property.

Declaration
public static DependencyProperty LoadInBackgroundProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

The identifier for the Syncfusion.UI.Xaml.Controls.PivotGrid.LoadInBackground dependency property.

LoadWithDefaultPropertyFieldsProperty

Identifies the LoadWithDefaultPropertyFields dependency property.

Declaration
public static DependencyProperty LoadWithDefaultPropertyFieldsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

OlapDataManagerProperty

Identifies the OlapDataManager dependency property.

Declaration
public static DependencyProperty OlapDataManagerProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

PivotCalculationsProperty

Identifies the PivotCalculations dependency property.

Declaration
public static DependencyProperty PivotCalculationsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

PivotColumnsProperty

Identifies the PivotColumns dependency property.

Declaration
public static DependencyProperty PivotColumnsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

PivotEngineProperty

Identifies the PivotEngine dependency property.

Declaration
public static DependencyProperty PivotEngineProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

PivotRowsProperty

Identifies the PivotRows dependency property.

Declaration
public static DependencyProperty PivotRowsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ResizeColumnsToFitProperty

Identifies the ResizeColumnsToFit dependency property.

Declaration
public static DependencyProperty ResizeColumnsToFitProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ResizeRowsToFitProperty

Identifies the ResizeRowsToFit dependency property.

Declaration
public static DependencyProperty ResizeRowsToFitProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

RowHeaderStyleProperty

Identifies the RowHeaderStyle dependency property.

Declaration
public static DependencyProperty RowHeaderStyleProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

SelectedCellProperty

Identifies the SelectedCell dependency property.

Declaration
public static DependencyProperty SelectedCellProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

SelectedItemsProperty

Identifies the SelectedItems dependency property.

Declaration
public static DependencyProperty SelectedItemsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowCalculationsAsColumnsProperty

Identifies the Syncfusion.UI.Xaml.PivotGrid.SfPivotGrid.ShowCalculationsAsColumn dependency property.

Declaration
public static DependencyProperty ShowCalculationsAsColumnsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowColumnSubTotalsProperty

Identifies the ShowColumnSubTotals dependency property.

Declaration
public static DependencyProperty ShowColumnSubTotalsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowGrandTotalsProperty

Identifies the ShowGrandTotals dependency property.

Declaration
public static DependencyProperty ShowGrandTotalsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowGroupingBarProperty

Identifies the ShowGroupingBar dependency property.

Declaration
public static DependencyProperty ShowGroupingBarProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowHeaderCellsToolTipProperty

Identifies the ShowHeaderCellsToolTip dependency property.

Declaration
public static DependencyProperty ShowHeaderCellsToolTipProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowPivotValueChooserProperty

Identifies the ShowPivotValueChooser dependency property.

Declaration
public static DependencyProperty ShowPivotValueChooserProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowProcessingBarProperty

Identifies the ShowProcessingBar dependency property.

Declaration
public static DependencyProperty ShowProcessingBarProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowRowSubTotalsProperty

Identifies the ShowRowSubTotals dependency property.

Declaration
public static DependencyProperty ShowRowSubTotalsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowSubTotalsProperty

Identifies the ShowSubTotals dependency property.

Declaration
public static DependencyProperty ShowSubTotalsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowValueCellToolTipProperty

Identifies the ShowValueCellToolTip dependency property.

Declaration
public static DependencyProperty ShowValueCellToolTipProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

SortOptionProperty

Identifies the SortOption dependency property.

Declaration
public static DependencyProperty SortOptionProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

SummaryColumnStyleProperty

Identifies the SummaryColumnStyle dependency property.

Declaration
public static DependencyProperty SummaryColumnStyleProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

SummaryRowStyleProperty

Identifies the SummaryRowStyle dependency property.

Declaration
public static DependencyProperty SummaryRowStyleProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ValueCellStyleProperty

Identifies the ValueCellStyle dependency property.

Declaration
public static DependencyProperty ValueCellStyleProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ValueCellTextAlignmentProperty

Identifies the ValueCellTextAlignment dependency property.

Declaration
public static DependencyProperty ValueCellTextAlignmentProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

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; }
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 columns to resize or not.

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

AllowResizeRows

Gets or sets a value indicating whether to allow rows to resize or not.

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

AllowSelection

Gets or sets a value indicating whether to allow cell selection or not.

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

AllowSelectionWithHeaders

Gets or sets a value indicating whether to allow selection of cells along with headers. This is applicable only for Relational data source

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

ColumnHeaderStyle

Gets or sets the style for column header cells.

Declaration
public PivotGridCellStyle ColumnHeaderStyle { get; set; }
Property Value
Type
PivotGridCellStyle

ConditionalFormats

Gets or sets the collection of conditional format to be applied for Pivot Grid.

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

EditManager

Gets or sets a reference to a class that facilitates editing of value cells. To enable this support, set EnableValueEditing to true.

Declaration
public PivotEditingManager EditManager { get; set; }
Property Value
Type
PivotEditingManager
Remarks

The EditManager handles direct editing of value cell contents. The Syncfusion.UI.Xaml.PivotGrid.PivotEditingManager.PivotValueEdited event to allow for controlling what happens as the cell as the user leaves the cell. You should handle this event if you want to do any actions when a cell is completed. The default behavior will adjust the edit cell value so the newly typed entry is displayed. Also, any display value that depends upon this edited cell will also be updated. If you set e.Handled = true when you handle the event, then EditManager will make no changes to the displayed information, and it would be up to you to make any adjustments you want to see.

The EditManager also has public properties AllowEditingOfTotalCells that control whether you can edit Total cells

EnableAutoExecute

Gets or sets whether the elements will automatically refresh in control.

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

Returns true if [EnableAutoExecute]; otherwise, false.

EnableColumnHeaderArea

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

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

Returns true if [EnableColumnHeaderArea]; otherwise, false.

EnableConditionalFormat

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

Declaration
public bool EnableConditionalFormat { 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 area items in GroupingBar.

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 a value indicating whether the removing is enabled in grouping bar.

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

EnableGroupingBarSorting

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

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 in GroupingBar.

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
Remarks

This is applicable only for relational data source.

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 area items in GroupingBar.

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

Returns true if [EnableValueHeaderArea]; otherwise, false.

ExpanderStyle

Gets or sets the style for expanders available in grid.

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

FieldChooser

Gets or sets the collection of pivot calculations.

Declaration
public PivotValueChooser FieldChooser { get; set; }
Property Value
Type
PivotValueChooser

FieldListBorderBrush

Gets or sets the border brush for Field List in GroupingBar.

Declaration
public Brush FieldListBorderBrush { get; set; }
Property Value
Type
Windows.UI.Xaml.Media.Brush

Filters

Gets the collection of filter expressions when using relational data source.

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

FreezeHeaders

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

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

GridArea

Gets or sets the grid area.

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

GridLayout

Gets or sets the grid layout to represent the data. This is applicable only for Relational data source.

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

GridLineStroke

Gets or sets the stroke for grid lines.

Declaration
public Brush GridLineStroke { get; set; }
Property Value
Type
Windows.UI.Xaml.Media.Brush

GridLineThickness

Gets or sets the thickness of grid lines.

Declaration
public double GridLineThickness { get; set; }
Property Value
Type
System.Double

GridSettings

Gets or sets the Grid appearance and report settings.

Declaration
public GridAppearanceSettings GridSettings { get; set; }
Property Value
Type
GridAppearanceSettings

GridStyleInfo

Gets or sets the style information for grid cells.

Declaration
public ExportingGridStyleInfo GridStyleInfo { get; set; }
Property Value
Type
ExportingGridStyleInfo

GridVisualStyle

Gets or sets the visual style for pivot grid.

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

GroupingBarBackground

Gets or sets the background brush for GroupingBar.

Declaration
public Brush GroupingBarBackground { get; set; }
Property Value
Type
Windows.UI.Xaml.Media.Brush

GroupingBarBorderBrush

Gets or sets the border brush for outer Grid.

Declaration
public Brush GroupingBarBorderBrush { get; set; }
Property Value
Type
Windows.UI.Xaml.Media.Brush

GroupingBarItemBackground

Gets or sets the background brush for the items in GroupingBar.

Declaration
public Brush GroupingBarItemBackground { get; set; }
Property Value
Type
Windows.UI.Xaml.Media.Brush

GroupingBarItemBorderBrush

Gets or sets the border brush for the items in GroupingBar.

Declaration
public Brush GroupingBarItemBorderBrush { get; set; }
Property Value
Type
Windows.UI.Xaml.Media.Brush

GroupingBarItemForeground

Gets or sets the foreground brush for the items in GroupingBar.

Declaration
public Brush GroupingBarItemForeground { get; set; }
Property Value
Type
Windows.UI.Xaml.Media.Brush

IgnoreExpandCollapseOnSerialization

Gets or sets whether the expand and collapse are ignoring on serialization.

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

ItemSource

Gets or sets source of data for this PivotTable. This object should be either an IEnumerable List.

Declaration
public object ItemSource { get; set; }
Property Value
Type
System.Object

Layout

Gets or sets the grid layout to represent the data. This is applicable only for OLAP data source.

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

LoadInBackground

Gets or sets whether the PivotGrid needs to be updated on the background using unique UI thread.

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

This is applicable only for relational data source.

LoadWithDefaultPropertyFields

Loads with default properties available in ItemsSource.

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

This is applicable only for relational data source.

OlapDataManager

Gets or sets the OLAP data manager.

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

PivotCalculations

Gets the collection of PivotCalculations when using relational data source.

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

PivotColumns

Gets the collection of PivotItems of PivotColumns when using the relational data source.

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

PivotEngine

Gets or sets the pivot engine.

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

PivotRows

Gets the collection of PivotItems of PivotRows when using relational data source

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 PivotGridCellStyle RowHeaderStyle { get; set; }
Property Value
Type Description
PivotGridCellStyle

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

SelectedCell

Gets or sets the cell that is selected in Pivot Grid.

Declaration
public PivotCellDescriptor SelectedCell { get; set; }
Property Value
Type
PivotCellDescriptor

SelectedItems

Gets the selected items which is an IEnumerable collection of columns, rows and values.

Declaration
public SelectedItems SelectedItems { get; }
Property Value
Type
SelectedItems

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
Remarks

This is applicable only for relational data source. The default value is false.

ShowGrandTotals

Gets or sets value to show/hide the grand totals.

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

ShowProcessingBar

Gets or sets a value indicating whether the progressing bar should be shown or not.

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

This is applicable only for relational data source. The default value is false.

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
Remarks

This is applicable only for relational data source. The default value is true.

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 PivotGridCellStyle SummaryColumnStyle { get; set; }
Property Value
Type
PivotGridCellStyle

SummaryRowStyle

Gets or sets the style for summary row cells.

Declaration
public PivotGridCellStyle SummaryRowStyle { get; set; }
Property Value
Type
PivotGridCellStyle

UpdateManager

Gets or sets a reference to a class that facilitates the PivotGrid getting automatically updating itself due to changes in the underlying data. To enable this support, set EnableUpdating to true.

Declaration
public PivotUpdatingManager UpdateManager { get; set; }
Property Value
Type
PivotUpdatingManager
Remarks

In order for the PivotGrid control to automatically respond to the changes in the underlying data, the underlying data must be either: A) an IList<T> where T implements both INotifyPropertyChanging and INotifyPropertyChanged. Additionally, the IList must also implement INotifyCollectionChanged or IBindingList.

ValueCellStyle

Gets or sets the style for value cells.

Declaration
public PivotGridCellStyle ValueCellStyle { get; set; }
Property Value
Type
PivotGridCellStyle

ValueCellTextAlignment

Gets or sets the text alignment for value cells.

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

Methods

add_AfterRefresh(PivotGridDrillDownEventHandler)

Declaration
public void add_AfterRefresh(PivotGridDrillDownEventHandler value)
Parameters
Type Name Description
PivotGridDrillDownEventHandler value

add_BeforeRefresh(PivotGridDrillDownEventHandler)

Declaration
public void add_BeforeRefresh(PivotGridDrillDownEventHandler value)
Parameters
Type Name Description
PivotGridDrillDownEventHandler value

add_ConditionalFormatApplied(ConditionalFormatsAppliedEventHandler)

Declaration
public void add_ConditionalFormatApplied(ConditionalFormatsAppliedEventHandler value)
Parameters
Type Name Description
ConditionalFormatsAppliedEventHandler value

add_FilterEditorPageNavigated(FilterEditorPageNavigatedEventHandler)

Declaration
public void add_FilterEditorPageNavigated(FilterEditorPageNavigatedEventHandler value)
Parameters
Type Name Description
FilterEditorPageNavigatedEventHandler value

add_LinkClick(LinkLabelClickEventHandler)

Declaration
public void add_LinkClick(LinkLabelClickEventHandler value)
Parameters
Type Name Description
LinkLabelClickEventHandler value

add_SelectionChanged(SelectionChangedEventHandler)

Declaration
public virtual void add_SelectionChanged(SelectionChangedEventHandler value)
Parameters
Type Name Description
SelectionChangedEventHandler value

DataBind()

Binds a data source to the Pivot Grid control and all its child controls.

Declaration
public void DataBind()

Deserialize()

De-serializes the XML file format into SfPivotGrid control.

Declaration
public void Deserialize()

Deserialize(Stream)

De-serialize the PivotGrid from the specified file stream.

Stream
Declaration
public void Deserialize(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

Deserialize(String)

De-serializes the XML string format into SfPivotGrid control.

Declaration
public void Deserialize(string xmlString)
Parameters
Type Name Description
System.String xmlString

Deserialize(StorageFile)

De-serialize the PivotGrid from the specified file.

Declaration
public void Deserialize(StorageFile storageFile)
Parameters
Type Name Description
Windows.Storage.StorageFile storageFile

Dispose()

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

Declaration
public void Dispose()

GetExportingGridStyleInfo()

Gets the exporting grid style information.

Declaration
public ExportingGridStyleInfo GetExportingGridStyleInfo()
Returns
Type
ExportingGridStyleInfo

OnApplyTemplate()

Builds the visual tree for this control when a new template is applied.

Declaration
protected override void OnApplyTemplate()

PopulateDefaultPropertyFields()

Populates default property fields.

Declaration
public void PopulateDefaultPropertyFields()

RaiseFilterEditorPageNavigated(FilterEditorPageNavigatedEventArgs)

Raises the Syncfusion.UI.Xaml.PivotGrid.FilterEditorPageNavigated event.

Declaration
public void RaiseFilterEditorPageNavigated(FilterEditorPageNavigatedEventArgs args)
Parameters
Type Name Description
FilterEditorPageNavigatedEventArgs args

The data for the event.

RaiseLoadInBackgroundCompleted()

Event raised when the Pivot completes its construction, when LoadInBackground is set to true.

Declaration
public void RaiseLoadInBackgroundCompleted()

Refresh()

Refreshes the grid to update values in grid cells.

Declaration
public void Refresh()

remove_AfterRefresh(PivotGridDrillDownEventHandler)

Declaration
public void remove_AfterRefresh(PivotGridDrillDownEventHandler value)
Parameters
Type Name Description
PivotGridDrillDownEventHandler value

remove_BeforeRefresh(PivotGridDrillDownEventHandler)

Declaration
public void remove_BeforeRefresh(PivotGridDrillDownEventHandler value)
Parameters
Type Name Description
PivotGridDrillDownEventHandler value

remove_ConditionalFormatApplied(ConditionalFormatsAppliedEventHandler)

Declaration
public void remove_ConditionalFormatApplied(ConditionalFormatsAppliedEventHandler value)
Parameters
Type Name Description
ConditionalFormatsAppliedEventHandler value

remove_FilterEditorPageNavigated(FilterEditorPageNavigatedEventHandler)

Declaration
public void remove_FilterEditorPageNavigated(FilterEditorPageNavigatedEventHandler value)
Parameters
Type Name Description
FilterEditorPageNavigatedEventHandler value

remove_LinkClick(LinkLabelClickEventHandler)

Declaration
public void remove_LinkClick(LinkLabelClickEventHandler value)
Parameters
Type Name Description
LinkLabelClickEventHandler value

remove_SelectionChanged(SelectionChangedEventHandler)

Declaration
public virtual void remove_SelectionChanged(SelectionChangedEventHandler value)
Parameters
Type Name Description
SelectionChangedEventHandler value

Serialize()

Serializes some specific properties in SfPivotGrid control.

Declaration
public void Serialize()

Serialize(Stream)

Serialize the PivotGrid from the specified file stream.

Stream
Declaration
public void Serialize(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

Serialize(StorageFile)

Serialize the PivotGrid from the specified file.

Declaration
public void Serialize(StorageFile storageFile)
Parameters
Type Name Description
Windows.Storage.StorageFile storageFile

SerializeToXml()

Serializes some specific properties in SfPivotGrid control into string format.

Declaration
public string SerializeToXml()
Returns
Type
System.String

Events

AfterRefresh

Occurs after the data gets refreshed.

Declaration
public event PivotGridDrillDownEventHandler AfterRefresh
Event Type
Type
PivotGridDrillDownEventHandler

BeforeRefresh

Occurs before the data gets refreshed.

Declaration
public event PivotGridDrillDownEventHandler BeforeRefresh
Event Type
Type
PivotGridDrillDownEventHandler

ConditionalFormatApplied

Occurs when the conditional format gets applied via the ConditionalFormatEditor window.

Declaration
public event ConditionalFormatsAppliedEventHandler ConditionalFormatApplied
Event Type
Type
ConditionalFormatsAppliedEventHandler

FilterEditorPageNavigated

Occurs when the filter editor navigation button clicked.

Declaration
public event FilterEditorPageNavigatedEventHandler FilterEditorPageNavigated
Event Type
Type
FilterEditorPageNavigatedEventHandler

LinkClick

Occurs when the hyperlink is clicked.

Declaration
public event LinkLabelClickEventHandler LinkClick
Event Type
Type
LinkLabelClickEventHandler

LoadInBackgroundCompleted

Occurs when LoadInBackGround operations completed.

Declaration
public event EventHandler LoadInBackgroundCompleted
Event Type
Type
System.EventHandler

SelectionChanged

Occurs when the cell gets selected in the Pivot Grid.

Declaration
public virtual event SelectionChangedEventHandler SelectionChanged
Event Type
Type
SelectionChangedEventHandler

Implements

System.IDisposable

Extension Methods