Class PivotGridControl

PivotGrid control provides the functionality of a PivotTable. A PivotTable is a data summarization tool which automatically sorts, filters and manipulates the PivotTable data, in different possible ways like-in Excel and represents them in cross-tabular format.

Inheritance
System.Object
PivotGridControl
Implements
System.IDisposable
Namespace: Syncfusion.Windows.Controls.PivotGrid
Assembly: Syncfusion.PivotAnalysis.WPF.dll
Syntax
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
public class PivotGridControl : Control, IPivotControl, IDisposable
Remarks

To use this control, you must set the ItemSource to some IList object. The object in the IList should have public property which you want to use it in the PivotTable. To represent the data in cross-tabular format you should specify the pivoting information in these properties PivotRows, PivotColumns and PivotCalculations

Constructors

PivotGridControl()

Initializes a new instance of the PivotGridControl class.

Declaration
public PivotGridControl()

Fields

AllowExcelLikeSummaryProperty

Identifies the AllowExcelLikeSummary dependency property.

Declaration
public static readonly DependencyProperty AllowExcelLikeSummaryProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the AllowExcelLikeSummary dependency property.

AllowResizeColumnsProperty

Identifies the AllowResizeColumns dependency property.

Declaration
public static readonly DependencyProperty AllowResizeColumnsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the AllowResizeColumns dependency property.

AllowResizeRowsProperty

Identifies the AllowResizeRows dependency property.

Declaration
public static readonly DependencyProperty AllowResizeRowsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the AllowResizeRows dependency property.

AllowRowHeaderAreaAutoSizingProperty

Identifies the AllowRowHeaderAreaAutoSizing dependency property.

Declaration
public static readonly DependencyProperty AllowRowHeaderAreaAutoSizingProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the AllowRowHeaderAreaAutoSizing dependency property.

AllowSelectionProperty

Identifies the AllowSelection dependency property.

Declaration
public static readonly DependencyProperty AllowSelectionProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the AllowSelection dependency property.

AllowSelectionWithHeadersProperty

Identifies the AllowSelectionWithHeaders dependency property.

Declaration
public static readonly DependencyProperty AllowSelectionWithHeadersProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the AllowSelectionWithHeaders dependency property.

AutoSizeOptionProperty

Identifies the AutoSizeOption dependency property.

Declaration
public static readonly DependencyProperty AutoSizeOptionProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the AutoSizeOption dependency property.

CalculatedFieldProperty

Identifies the CalculatedField dependency property.

Declaration
public static readonly DependencyProperty CalculatedFieldProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the CalculatedField dependency property.

ColorScaleConditionalFormatsProperty

Identifies the Syncfusion.Windows.Controls.PivotGrid.PivotGridControl.PivotGridConditionalFormats dependency property.

Declaration
public static readonly DependencyProperty ColorScaleConditionalFormatsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the Syncfusion.Windows.Controls.PivotGrid.PivotGridControl.PivotGridConditionalFormats dependency property.

ColumnHeaderCellStyleProperty

Identifies the ColumnHeaderCellStyle dependency property.

Declaration
public static readonly DependencyProperty ColumnHeaderCellStyleProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ColumnHeaderCellStyle dependency property.

ConditionalFormatsProperty

Identifies the ConditionalFormats dependency property.

Declaration
public static readonly DependencyProperty ConditionalFormatsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ConditionalFormats dependency property.

CurrentCellBorderProperty

Identifies the CurrentCellBorder dependency property.

Declaration
public static readonly DependencyProperty CurrentCellBorderProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the CurrentCellBorder dependency property.

CustomToolTipTemplateKeyProperty

Identifies the CustomToolTipTemplateKey dependency property.

Declaration
public static readonly DependencyProperty CustomToolTipTemplateKeyProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the CustomToolTipTemplateKey dependency property.

DeferLayoutUpdateProperty

Identifies the DeferLayoutUpdate dependency property.

Declaration
public static readonly DependencyProperty DeferLayoutUpdateProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the DeferLayoutUpdate dependency property.

EnableColumnHeaderProperty

Identifies the EnableColumnHeader dependency property.

Declaration
public static readonly DependencyProperty EnableColumnHeaderProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the EnableColumnHeader dependency property.

EnableDeferredScrollingProperty

Identifies the EnableDeferredScrolling dependency property.

Declaration
public static readonly DependencyProperty EnableDeferredScrollingProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the EnableDeferredScrolling dependency property.

EnableHyperlinkOnMouseOverProperty

Identifies the Syncfusion.Windows.Controls.PivotGrid.PivotGridControl.EnableHyperlinkOnMouseHover dependency property.

Declaration
public static readonly DependencyProperty EnableHyperlinkOnMouseOverProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the Syncfusion.Windows.Controls.PivotGrid.PivotGridControl.EnableHyperlinkOnMouseHover dependency property.

EnableRowHeaderProperty

Identifies the EnableRowHeader dependency property.

Declaration
public static readonly DependencyProperty EnableRowHeaderProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the EnableRowHeader dependency property.

EnableSpecificColumnEditingProperty

Identifies the EnableSpecificColumnEditing dependency property.

Declaration
public static readonly DependencyProperty EnableSpecificColumnEditingProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the EnableSpecificColumnEditing dependency property.

EnableUpdatingProperty

Identifies the EnableUpdating dependency property.

Declaration
public static readonly DependencyProperty EnableUpdatingProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the EnableUpdating dependency property.

EnableValueEditingProperty

Identifies the EnableValueEditing dependency property.

Declaration
public static readonly DependencyProperty EnableValueEditingProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the EnableValueEditing dependency property.

ExpanderStyleProperty

Identifies the ExpanderStyle dependency property.

Declaration
public static readonly DependencyProperty ExpanderStyleProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ExpanderStyle dependency property.

FieldListBorderBrushProperty

Identifies the FieldListBorderBrush dependency property.

Declaration
public static readonly DependencyProperty FieldListBorderBrushProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the FieldListBorderBrush dependency property.

FilterIndex

Variable to maintain the current index of the filter item.

Declaration
public static int FilterIndex
Field Value
Type
System.Int32

FiltersProperty

Identifies the Filters dependency property.

Declaration
public static readonly DependencyProperty FiltersProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the Filters dependency property.

FreezeHeadersProperty

Identifies the FreezeHeaders dependency property.

Declaration
public static readonly DependencyProperty FreezeHeadersProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the FreezeHeaders dependency property.

GridLayoutProperty

Identifies the GridLayout dependency property.

Declaration
public static readonly DependencyProperty GridLayoutProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GridLayout dependency property.

GridLineStrokeProperty

Identifies the GridLineStroke dependency property.

Declaration
public static readonly DependencyProperty GridLineStrokeProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GridLineStroke dependency property.

GridOuterBorderBrushProperty

Identifies the GridOuterBorderBrush dependency property.

Declaration
public static readonly DependencyProperty GridOuterBorderBrushProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GridOuterBorderBrush dependency property.

GroupingBarBackgroundProperty

Identifies the GroupingBarBackground dependency property.

Declaration
public static readonly DependencyProperty GroupingBarBackgroundProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GroupingBarBackground dependency property.

GroupingBarItemBackgroundProperty

Identifies the GroupingBarItemBackground dependency property.

Declaration
public static readonly DependencyProperty GroupingBarItemBackgroundProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GroupingBarItemBackground dependency property.

GroupingBarItemBorderBrushProperty

Identifies the GroupingBarItemBorderBrush dependency property.

Declaration
public static readonly DependencyProperty GroupingBarItemBorderBrushProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GroupingBarItemBorderBrush dependency property.

GroupingBarItemForegroundProperty

Identifies the GroupingBarItemForeground dependency property.

Declaration
public static readonly DependencyProperty GroupingBarItemForegroundProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GroupingBarItemForeground dependency property.

GroupingBarProperty

Identifies the GroupingBar dependency property.

Declaration
public static readonly DependencyProperty GroupingBarProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GroupingBar dependency property.

GroupingButtonCheckedBackgroundProperty

Identifies the GroupingButtonCheckedBackground dependency property.

Declaration
public static readonly DependencyProperty GroupingButtonCheckedBackgroundProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GroupingButtonCheckedBackground dependency property.

GroupingButtonCheckedForegroundProperty

Identifies the GroupingButtonCheckedForeground dependency property.

Declaration
public static readonly DependencyProperty GroupingButtonCheckedForegroundProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GroupingButtonCheckedForeground dependency property.

GroupingButtonHoverBackgroundBrushProperty

Identifies the GroupingButtonHoverBackgroundBrush dependency property.

Declaration
public static readonly DependencyProperty GroupingButtonHoverBackgroundBrushProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GroupingButtonHoverBackgroundBrush dependency property.

GroupingButtonHoverBorderBrushProperty

Identifies the GroupingButtonHoverBorderBrush dependency property.

Declaration
public static readonly DependencyProperty GroupingButtonHoverBorderBrushProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GroupingButtonHoverBorderBrush dependency property.

GroupingButtonHoverForegroundProperty

Identifies the GroupingButtonHoverForeground dependency property.

Declaration
public static readonly DependencyProperty GroupingButtonHoverForegroundProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the GroupingButtonHoverForeground dependency property.

IsDataDynamicProperty

Identifies the IsDataDynamic dependency property.

Declaration
public static readonly DependencyProperty IsDataDynamicProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the IsDataDynamic dependency property.

IsDynamicDataProperty

Identifies the IsDynamicData dependency property.

Declaration
public static readonly DependencyProperty IsDynamicDataProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the IsDynamicData dependency property.

ItemSourceProperty

Identifies the ItemSource dependency property.

Declaration
public static readonly DependencyProperty ItemSourceProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ItemSource dependency property.

LoadInBackgroundProperty

Identifies the LoadInBackground dependency property.

Declaration
public static readonly DependencyProperty LoadInBackgroundProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the LoadInBackground dependency property.

LoadWithDefaultPropertyFieldsProperty

Loads with default properties available in ItemsSource.

Declaration
public static readonly DependencyProperty LoadWithDefaultPropertyFieldsProperty
Field Value
Type
System.Windows.DependencyProperty

PivotCalculationsProperty

Identifies the PivotCalculations dependency property.

Declaration
public static readonly DependencyProperty PivotCalculationsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the PivotCalculations dependency property.

PivotColumnsProperty

Identifies the PivotColumns dependency property.

Declaration
public static readonly DependencyProperty PivotColumnsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the PivotColumns dependency property.

PivotEngineProperty

Identifies the PivotEngine dependency property.

Declaration
public static readonly DependencyProperty PivotEngineProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the PivotEngine dependency property.

PivotRowsProperty

Identifies the PivotRows dependency property.

Declaration
public static readonly DependencyProperty PivotRowsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the PivotRows dependency property.

PossiblePivotCalculationsProperty

Identifies the PossiblePivotCalculations dependency property.

Declaration
public static readonly DependencyProperty PossiblePivotCalculationsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the PossiblePivotCalculations dependency property.

ResizePivotGridToFitProperty

Identifies the Syncfusion.Windows.Controls.PivotGrid.PivotGridControl.ResizeToFit dependency property.

Declaration
public static readonly DependencyProperty ResizePivotGridToFitProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the Syncfusion.Windows.Controls.PivotGrid.PivotGridControl.ResizeToFit dependency property.

RowHeaderCellStyleProperty

Identifies the RowHeaderCellStyle dependency property.

Declaration
public static readonly DependencyProperty RowHeaderCellStyleProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the RowHeaderCellStyle dependency property.

SelectedCellProperty

Identifies the SelectedCell dependency property.

Declaration
public static readonly DependencyProperty SelectedCellProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the SelectedCell dependency property.

SelectedItemsProperty

Identifies the SelectedItems dependency property.

Declaration
public static readonly DependencyProperty SelectedItemsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the SelectedItems dependency property.

ShowCalculationsAsColumnsProperty

Identifies the ShowCalculationsAsColumns dependency property.

Declaration
public static readonly DependencyProperty ShowCalculationsAsColumnsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ShowCalculationsAsColumns dependency property.

ShowColumnSubTotalsProperty

Identifies the ShowColumnSubTotals dependency property.

Declaration
public static readonly DependencyProperty ShowColumnSubTotalsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ShowColumnSubTotals dependency property.

ShowDisabledGroupBackgroundProperty

Identifies the ShowDisabledGroupBackground dependency property.

Declaration
public static readonly DependencyProperty ShowDisabledGroupBackgroundProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ShowDisabledGroupBackground dependency property.

ShowEmptyCellsProperty

Identifies the ShowEmptyCells dependency property.

Declaration
public static readonly DependencyProperty ShowEmptyCellsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ShowEmptyCells dependency property.

ShowFieldListProperty

Identifies the ShowFieldList dependency property.

Declaration
public static readonly DependencyProperty ShowFieldListProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ShowFieldList dependency property.

ShowGrandTotalsProperty

Identifies the ShowGrandTotals dependency property.

Declaration
public static readonly DependencyProperty ShowGrandTotalsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ShowGrandTotals dependency property.

ShowGroupingBarProperty

Identifies the ShowGroupingBar dependency property.

Declaration
public static readonly DependencyProperty ShowGroupingBarProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ShowGroupingBar dependency property.

ShowPivotValueChooserProperty

Identifies the ShowPivotValueChooser dependency property.

Declaration
public static readonly DependencyProperty ShowPivotValueChooserProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ShowPivotValueChooser dependency property.

ShowRowSubTotalsProperty

Identifies the ShowRowSubTotals dependency property.

Declaration
public static readonly DependencyProperty ShowRowSubTotalsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ShowRowSubTotals dependency property.

ShowSubTotalsForChildrenProperty

Identifies the ShowSubTotalsForChildren dependency property.

Declaration
public static readonly DependencyProperty ShowSubTotalsForChildrenProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ShowSubTotalsForChildren dependency property.

ShowSubTotalsProperty

Identifies the ShowSubTotals dependency property.

Declaration
public static readonly DependencyProperty ShowSubTotalsProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ShowSubTotals dependency property.

SortOptionProperty

Identifies the SortOption dependency property.

Declaration
public static readonly DependencyProperty SortOptionProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the SortOption dependency property.

StatePersistenceEnabledProperty

Identifies the StatePersistenceEnabled dependency property.

Declaration
public static readonly DependencyProperty StatePersistenceEnabledProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the StatePersistenceEnabled dependency property.

StaticValueColumnWidthProperty

Identifies the StaticValueColumnWidth dependency property.

Declaration
public static readonly DependencyProperty StaticValueColumnWidthProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the StaticValueColumnWidth dependency property.

SummaryCellStyleProperty

Identifies the SummaryCellStyle dependency property.

Declaration
public static readonly DependencyProperty SummaryCellStyleProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the SummaryCellStyle dependency property.

SummaryColumnHeaderStyleProperty

Identifies the SummaryColumnHeaderStyle dependency property.

Declaration
public static readonly DependencyProperty SummaryColumnHeaderStyleProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the SummaryColumnHeaderStyle dependency property.

SummaryHeaderStyleProperty

Identifies the SummaryHeaderStyle dependency property.

Declaration
public static readonly DependencyProperty SummaryHeaderStyleProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the SummaryHeaderStyle dependency property.

SummaryRowHeaderStyleProperty

Identifies the SummaryRowHeaderStyle dependency property.

Declaration
public static readonly DependencyProperty SummaryRowHeaderStyleProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the SummaryRowHeaderStyle dependency property.

ToolTipEnabledProperty

Identifies the ToolTipEnabled dependency property.

Declaration
public static readonly DependencyProperty ToolTipEnabledProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ToolTipEnabled dependency property.

ValueCellStyleProperty

Identifies the ValueCellStyle dependency property.

Declaration
public static readonly DependencyProperty ValueCellStyleProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the ValueCellStyle dependency property.

VisualStyleProperty

Identifies the VisualStyle dependency property.

Declaration
public static readonly DependencyProperty VisualStyleProperty
Field Value
Type Description
System.Windows.DependencyProperty

The identifier for the VisualStyle dependency property.

Properties

AllowedFields

Gets a collection of Syncfusion.PivotAnalysis.Base.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.

AllowExcelLikeSummary

Gets or sets the value to set the SummaryType as Normal or Excel_like

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

true if [allow resize 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

true if [allow resize rows]; otherwise, false.

AllowRowHeaderAreaAutoSizing

Gets or sets to restrict the row headers stretching when too many items are in the PivotGrid GroupingBar computation area. For example: If we have more than two items in the PivotGridComputationArea, then an button(down Arrow) appears after the computation area in the GroupingBar. Click event of the button results in opening a new PivotGridComputationList window with the items in the computation area. We can perform drag and drop operation of the items between the GroupingBar area (Row/Column/Data/Filter Areas) and PivotGridComputationList window.

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

AllowSelection

Gets or sets a value indicating whether to allow selection of cells, like-in Excel.

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

true if [allow selection]; otherwise, false.

AllowSelectionWithHeaders

Gets or sets a value indicating whether to allow selection of cells along with headers, like-in Excel.

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

true if [allow selection with headers]; otherwise, false.

AutoSizeColumnCount

Gets or sets a 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 PivotGrid 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

CalculatedField

Gets or sets a value indicating whether to show/hide the calculated field.

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

ColorScaleConditionalFormats

Gets or sets the conditional formats to be applied for PivotGrid control.

Declaration
public FreezableCollection<PivotGridColorScaleConditionalFormat> ColorScaleConditionalFormats { get; set; }
Property Value
Type Description
System.Windows.FreezableCollection<PivotGridColorScaleConditionalFormat>

The conditional formats.

ColumnHeaderCellStyle

Gets or sets the templates and appearance of column header cells.

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

ConditionalFormats

Gets or sets the conditional formats to be applied for PivotGrid control.

Declaration
public FreezableCollection<PivotGridDataConditionalFormat> ConditionalFormats { get; set; }
Property Value
Type Description
System.Windows.FreezableCollection<PivotGridDataConditionalFormat>

The conditional formats.

CurrentCellBorder

Gets or sets the current cell border.

Declaration
public Brush CurrentCellBorder { get; set; }
Property Value
Type
System.Windows.Media.Brush

CustomToolTipTemplateKey

Gets or sets custom ToolTip template key.

Declaration
public string CustomToolTipTemplateKey { get; set; }
Property Value
Type
System.String

DeferLayoutUpdate

Gets or sets whether the layout should be updated immediately after
Pivot information update or it should wait for a Refresh() call.

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

EditColumnList

Gets or sets the list of column names which needs to be in edit mode.

Declaration
public List<string> EditColumnList { get; set; }
Property Value
Type
System.Collections.Generic.List<System.String>

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 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 and HideExpanders that control whether you can edit Total cells and whether the expander glyphs are visible.

The EditManager has two public methods GetRowColumnPivotValuesAt(Int32, Int32, out String) and GetRawItemsFor(Int32, Int32) that return lists of PivotValues and raw data items for a specified row and column.

EnableColumnHeader

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

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

true, if [enable column header]; otherwise, false.

EnableDeferredScrolling

Update the data in Grid, only when the user releases the thumb on scrolling. It is used to improve the scrolling performance.

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

EnableRowHeader

Gets or sets to show/hide row header items in GroupingBar.

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

true, if [enable row header]; otherwise, false.

EnableSpecificColumnEditing

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

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

ExpanderStyle

Gets or sets the expander cell style.

Declaration
public Style ExpanderStyle { get; set; }
Property Value
Type Description
System.Windows.Style

The expander style.

ExportComputations

Gets or sets the export computations collection.

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

ExportFilters

Gets or sets the export filters collection.

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

FieldListBorderBrush

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

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

Filters

Gets the collection of filter expressions.

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

FreezeHeaders

Gets or sets whether the row, column headers should frozen or not.

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

GrandTotalRowAlwaysVisible

Gets or sets whether the grand total row is always visible at the bottom of the PivotGrid control. The default setting is false.

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

GridLayout

Gets or sets a value indicating whether sub-total calculations should be shown on top of the PivotGrid or not.

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

The default value is Normal.

GridLineStroke

Gets or sets the color for GridLineStroke.

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

GridOuterBorderBrush

Gets or sets the border brush for outer Grid.

Declaration
public Brush GridOuterBorderBrush { get; set; }
Property Value
Type
System.Windows.Media.Brush

GroupingBar

The PivotGrid GroupingBar enables the drag and drop feature of fields between different areas like column, row, value and filter.

Declaration
public PivotGridGroupingBar GroupingBar { get; set; }
Property Value
Type Description
PivotGridGroupingBar

The GroupingBar.

GroupingBarBackground

Gets or sets the background brush for GroupingBar.

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

GroupingBarItemBackground

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

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

GroupingBarItemBorderBrush

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

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

GroupingBarItemForeground

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

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

GroupingButtonCheckedBackground

Gets or sets the background brush for the checked items(ToggleButtons) in GroupingBar.

Declaration
public Brush GroupingButtonCheckedBackground { get; set; }
Property Value
Type
System.Windows.Media.Brush

GroupingButtonCheckedForeground

Gets or sets the foreground brush for the checked items(ToggleButtons) in GroupingBar.

Declaration
public Brush GroupingButtonCheckedForeground { get; set; }
Property Value
Type
System.Windows.Media.Brush

GroupingButtonHoverBackgroundBrush

Gets or sets the background brush while hovering ToggleButtons in GroupingBar.

Declaration
public Brush GroupingButtonHoverBackgroundBrush { get; set; }
Property Value
Type
System.Windows.Media.Brush

GroupingButtonHoverBorderBrush

Gets or sets the border brush while hovering ToggleButtons in GroupingBar.

Declaration
public Brush GroupingButtonHoverBorderBrush { get; set; }
Property Value
Type
System.Windows.Media.Brush

GroupingButtonHoverForeground

Gets or sets the foreground brush while hovering ToggleButtons in GroupingBar.

Declaration
public Brush GroupingButtonHoverForeground { get; set; }
Property Value
Type
System.Windows.Media.Brush

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.

IgnoreRefesh

Gets or sets whether we can refresh the PivotGrid or not.

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

IgnoreRefresh

Gets or sets whether we can refresh the PivotGrid or not.

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

IsDataDynamic

Gets or sets whether the DataSource is a collection of dynamic objects supported in the .Net framework 4.0.

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

IsDynamicData

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

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

IsExternalEngine

Gets or sets whether the Engine of this control is internally created or supplied from external source.

Declaration
public bool IsExternalEngine { 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, or a DataTable.

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

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

LoadWithDefaultPropertyFields

Gets or sets a value indicating whether PivotGrid loads with default property fields for expression support.

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

Returns true, if [load with default property fields]; otherwise, false.

PivotCalculations

Gets the collection of PivotCalculations.

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

PivotColumns

Gets the collection of PivotItems of PivotColumns.

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

PivotEngine

Gets or sets the PivotEngine.

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

PivotFields

Gets the collection of PivotItems of PivotFieldList.

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

PivotRows

Gets the collection of PivotItems of PivotRows.

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

PivotValueChooserItemFontSize

Gets or sets the size of the font used in the PivotValueChooser window. The PivotValueChooser is only available when "RowPivotsOnly" is true.

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

PivotValueChooserItemHeight

Gets or sets the height of the items listed in the PivotValueChooser window. The PivotValueChooser is only available when "RowPivotsOnly" is true.

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

PossiblePivotCalculations

Gets or sets a collection of possible PivotCalculations that may appear in the PivotGrid control when "RowPivotsOnly" is true.

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

ResizePivotGridToFit

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

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

RowHeaderCellStyle

Gets or sets the templates and appearance of row header cells.

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

RowPivotsOnly

Gets or sets whether this PivotGrid control can pivot both rows and columns, or only rows. The default value is false. Setting this property to true will

  1. automatically set ShowGroupingBar to false.
  2. Replace the TopLeft covered cell that normally appears in a PivotGrid with individual header cells that appear the same as calculation header cells.

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

SelectedCell

Gets or sets the selected cell of PivotGrid control.

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

SelectedItems

Gets or sets the selected items which is an IEnumerable collection of columns, rows and value.

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

The selected items.

ShowCalculationsAsColumns

Gets or sets whether the calculations should appear as rows or 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

The default value is false.

ShowDisabledGroupBackground

Enable/disable the PivotItems in the GroupingBar. 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 it is true.

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

ShowExpanderForSinglePivot

Gets or sets whether expander symbol needs to be show/hide when PivotGrid has a single PivotItem.

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

ShowFieldList

Gets or sets a value indication whether to show/hide the Field List window.

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

ShowGrandTotals

Gets or sets whether 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 to show/hide the GroupingBar in PivotGrid control.

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

true, if [show grouping bar]; otherwise, false.

ShowPivotValueChooser

Shows/hides PivotValueChooser dialog.

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
Remarks

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

The default value is true.

ShowSubTotalsForChildren

Gets or sets value to show/hide the sub-total for children.

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

The default value is false.

SortOption

Gets or sets the option for sorting in PivotGrid control.

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

StatePersistenceEnabled

Gets or sets a value indicating whether to maintain the state of cells when Pivot Schema gets changed.

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

StaticValueColumnWidth

Gets or sets the static column width is applied to all the columns w.r.t to improve the performance.

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

SummaryCellStyle

Gets or sets the templates and appearance of summary cells.

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

SummaryColumnHeaderStyle

Gets or sets the templates and appearance of summary column header cells.

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

SummaryHeaderStyle

Gets or sets the templates and appearance of summary header cells.

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

SummaryRowHeaderStyle

Gets or sets the templates and appearance of summary row header cells.

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

ToolTipEnabled

Gets or sets a value to enable/disable ToolTip.

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

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) a DataTable or DataView or B) an IList<T> where T implements both INotifyPropertyChanging and INotifyPropertyChanged. Additionally, the IList must also implement INotifyCollectionChanged or IBindingList.

ValueCellStyle

Gets or sets the templates and appearance fo value cells.

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

ValueChooserSize

Gets or sets the size of the PivotValueChooser window which is only available when "RowPivotsOnly" is true.

Declaration
public Size ValueChooserSize { get; set; }
Property Value
Type
System.Windows.Size

VisualStyle

Gets or sets the visual style property of PivotGrid control.

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

Methods

add_Collapsed(Collapsed)

Declaration
public virtual void add_Collapsed(Collapsed value)
Parameters
Type Name Description
Collapsed value

add_Collapsing(Collapsing)

Declaration
public virtual void add_Collapsing(Collapsing value)
Parameters
Type Name Description
Collapsing value

add_DataRefreshed(DataRefreshed)

Declaration
public virtual void add_DataRefreshed(DataRefreshed value)
Parameters
Type Name Description
DataRefreshed value

add_DataRefreshing(DataRefreshing)

Declaration
public virtual void add_DataRefreshing(DataRefreshing value)
Parameters
Type Name Description
DataRefreshing value

add_Expanded(Expanded)

Declaration
public virtual void add_Expanded(Expanded value)
Parameters
Type Name Description
Expanded value

add_Expanding(Expanding)

Declaration
public virtual void add_Expanding(Expanding value)
Parameters
Type Name Description
Expanding value

add_FilterActionCompleted(FilterActionCompletedEventHandler)

Declaration
public virtual void add_FilterActionCompleted(FilterActionCompletedEventHandler value)
Parameters
Type Name Description
FilterActionCompletedEventHandler value

add_GroupingBarLoaded(GroupingBarLoaded)

Declaration
public virtual void add_GroupingBarLoaded(GroupingBarLoaded value)
Parameters
Type Name Description
GroupingBarLoaded value

add_HyperlinkCellClick(HyperlinkCellClick)

Declaration
public virtual void add_HyperlinkCellClick(HyperlinkCellClick value)
Parameters
Type Name Description
HyperlinkCellClick value

add_ItemSourceChanged(ItemSourceChanged)

Declaration
public virtual void add_ItemSourceChanged(ItemSourceChanged value)
Parameters
Type Name Description
ItemSourceChanged value

add_SelectionChanged(SelectionChanged)

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

add_SortBegin(SortBegin)

Declaration
public virtual void add_SortBegin(SortBegin value)
Parameters
Type Name Description
SortBegin value

add_SortCompleted(SortCompleted)

Declaration
public virtual void add_SortCompleted(SortCompleted value)
Parameters
Type Name Description
SortCompleted value

CellStyle_PropertyChanged(Object, PropertyChangedEventArgs)

Handles the property changed event for the cell style.

Declaration
public void CellStyle_PropertyChanged(object sender, PropertyChangedEventArgs e)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.ComponentModel.PropertyChangedEventArgs e

The System.ComponentModel.PropertyChangedEventArgs instance containing the event data.

CollapseAllGroup()

Collapses all the group.

Declaration
public void CollapseAllGroup()

CollapseColumn(List<String>)

Collapse the columns for the provided array of unique text.

Declaration
public void CollapseColumn(List<string> list)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> list

Array of unique text of the expanded headers.

CollapseColumn(String)

Collapses the column of the specified unique text.

Declaration
public void CollapseColumn(string uniqueText)
Parameters
Type Name Description
System.String uniqueText

Unique text of the expanded header.

CollapseRow(List<String>)

Collapse the rows for the provided array of unique text.

Declaration
public void CollapseRow(List<string> list)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> list

Array of unique text of the expanded headers.

CollapseRow(String)

Collapses the row of the specified unique text.

Declaration
public void CollapseRow(string uniqueText)
Parameters
Type Name Description
System.String uniqueText

Unique text of the expanded header.

Deserialize()

De-serializes the XML file format into PivotGrid control.

Declaration
public void Deserialize()

Deserialize(String)

De-serializes the given file content into PivotGrid control.

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

DeserializeXmlString(String)

De-serializes the XML string format into PivotGrid control.

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

Dispose()

Releases all the resources used by this component.

Declaration
public void Dispose()

DoLazyCalculations()

This method triggers the lazy idle calculations of summaries when "EnableLoadOnDemandCalculations" is true.

Declaration
public void DoLazyCalculations()

EnableRowHeaderPropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when row header property changed.

Declaration
public static void EnableRowHeaderPropertyChanged(DependencyObject dependencyobject, DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyObject dependencyobject

The dependency object.
System.Windows.DependencyPropertyChangedEventArgs e

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

ExpandAllGroup()

Expands all the group.

Declaration
public void ExpandAllGroup()

ExpandCollapseAtLevel(String, Boolean)

When "RowPivotsOnly" is true, this method expands/collapses all groups under a particular row.

Declaration
public void ExpandCollapseAtLevel(string rowPivotFieldName, bool expand)
Parameters
Type Name Description
System.String rowPivotFieldName

The mapping name for the row PivotFields. If this string is empty or null, all nodes will be affected.
System.Boolean expand

Passes true, to expand all nodes and false, to collapse them.

ExpandColumn(List<String>)

Expand the columns for the provided array of unique text.

Declaration
public void ExpandColumn(List<string> list)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> list

Array of unique text of the expanded headers.

ExpandColumn(String)

Expands the column of the specified unique text.

Declaration
public void ExpandColumn(string uniqueText)
Parameters
Type Name Description
System.String uniqueText

Unique text of the expanded header.

ExpandRow(List<String>)

Expands the rows for the provided array of unique text.

Declaration
public void ExpandRow(List<string> list)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> list

Array of unique text of the expanded headers.

ExpandRow(String)

Expands the row of the specified unique text.

Declaration
public void ExpandRow(string uniqueText)
Parameters
Type Name Description
System.String uniqueText

Unique text of the expanded header.

GetFilteredFieldValues(String, Boolean)

When "RowPivotsOnly" is true, returns a list of filtered values associated with a specified value column.

Declaration
public List<string> GetFilteredFieldValues(string fieldName, bool returnExclusions)
Parameters
Type Name Description
System.String fieldName

The field name of the column, whose filtered values should be returned.
System.Boolean returnExclusions

Passes true, if you want the excluded values returned and false, is you want to the included values returned.
Returns
Type Description
System.Collections.Generic.List<System.String>

The requested list of values.

GetFilteredValueFields()

When "RowPivotsOnly" is true, this method returns the field names of the currently filtered values.

Declaration
public List<string> GetFilteredValueFields()
Returns
Type Description
System.Collections.Generic.List<System.String>

A list of names for the currently filtered value columns.

GetSortedValueFields(out List<String>, out List<ListSortDirection>)

When "RowPivotsOnly" is true, this method returns information on the currently sorted value fields.

Declaration
public void GetSortedValueFields(out List<string> fieldNames, out List<ListSortDirection> sortDirections)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> fieldNames

Returns a list of the sorted field names, in the order, it was sorted.
System.Collections.Generic.List<System.ComponentModel.ListSortDirection> sortDirections

Returns a list of sort direction, for each sorted value fields, in the order, it was sorted.

InitializePossibleCalculations()

It is used to initialize the possible PivotCalculations for SchemaDesigner when "RowPivotsOnly" mode is enabled. Adding the remaining properties from the ItemSource which are not defined in PivotRows or PivotColumns or PivotCalculations to the mentioned collection.

Declaration
public void InitializePossibleCalculations()

InvalidateCells()

Invalidates the cells.

Declaration
public void InvalidateCells()

LoadPivotInBackground()

Builds a pivot using the current schema on a background thread, so that the UI thread is responsive.

Declaration
public void LoadPivotInBackground()

OnApplyTemplate()

When overridden in a derived class, it is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

Declaration
public override void OnApplyTemplate()

OnCreateAutomationPeer()

returns the new automation peer class for the PivotGridControl

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
Type
System.Windows.Automation.Peers.AutomationPeer

OnShowDisabledGroupBackgroundPropertyChanged(Object, EventArgs)

Calls when the value of the property "ShowDisabledGroupBackground" changes.

Declaration
protected virtual void OnShowDisabledGroupBackgroundPropertyChanged(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender
System.EventArgs e

PopulateDefaultPropertyFields()

Populates the default property fields.

Declaration
public void PopulateDefaultPropertyFields()

RaiseFilterActionCompleted(FilterActionCompletedEventArgs)

Event raised after filtering.

Declaration
public void RaiseFilterActionCompleted(FilterActionCompletedEventArgs e)
Parameters
Type Name Description
FilterActionCompletedEventArgs e

The FilterActionCompletedEventArgs instance containing the event data.

RaiseLoadInBackgroundCompleted()

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

Declaration
public void RaiseLoadInBackgroundCompleted()

RaiseOnCollapsing(CollapsingEventArgs, GridStyleInfo)

Event raised during collapsing.

Declaration
public void RaiseOnCollapsing(CollapsingEventArgs collapsingEventArgs, GridStyleInfo styleInfo)
Parameters
Type Name Description
CollapsingEventArgs collapsingEventArgs

The CollapsingEventArgs instance containing the event data.
GridStyleInfo styleInfo

The style information.

RaiseOnExpanding(ExpandingEventArgs, PivotCellInfo)

Event raised during expanding.

Declaration
public void RaiseOnExpanding(ExpandingEventArgs expandingEventArgs, PivotCellInfo OriginalCell)
Parameters
Type Name Description
ExpandingEventArgs expandingEventArgs

The ExpandingEventArgs instance containing the event data.
PivotCellInfo OriginalCell

Holds pivot cell information.

RaiseSortActionBegin(OnSortActionStarted, PivotItem, PivotCellInfo, Dictionary<Int32, Object>)

Represents the method that will handle the event before sorting in PivotGrid.

Declaration
public void RaiseSortActionBegin(OnSortActionStarted onSortActionStarted, PivotItem pivotItem, PivotCellInfo cellInfo, Dictionary<int, object> list)
Parameters
Type Name Description
OnSortActionStarted onSortActionStarted

Containing event data related to sort action initiated in PivotGrid control
PivotItem pivotItem

The PivotItem for sorting.
PivotCellInfo cellInfo

Holds Pivot cell information
System.Collections.Generic.Dictionary<System.Int32, System.Object> list

List of sort items in the PivotGrid.

RaiseSortActionCompleted(OnSortActionCompleted, PivotItem, PivotCellInfo, Dictionary<Int32, Object>)

Represents the method that will handle the event after sorting in PivotGrid.

Declaration
public void RaiseSortActionCompleted(OnSortActionCompleted onSortActionCompleted, PivotItem pivotItem, PivotCellInfo cellInfo, Dictionary<int, object> list)
Parameters
Type Name Description
OnSortActionCompleted onSortActionCompleted

Containing event data related to sort action complete in PivotGrid control.
PivotItem pivotItem

The PivotItem for sorting.
PivotCellInfo cellInfo

Holds Pivot cell information.
System.Collections.Generic.Dictionary<System.Int32, System.Object> list

List of sort items in the PivotGrid.

Refresh()

Refreshes the PivotGrid control with latest data and invalidates the Grid.

Declaration
public void Refresh()

remove_Collapsed(Collapsed)

Declaration
public virtual void remove_Collapsed(Collapsed value)
Parameters
Type Name Description
Collapsed value

remove_Collapsing(Collapsing)

Declaration
public virtual void remove_Collapsing(Collapsing value)
Parameters
Type Name Description
Collapsing value

remove_DataRefreshed(DataRefreshed)

Declaration
public virtual void remove_DataRefreshed(DataRefreshed value)
Parameters
Type Name Description
DataRefreshed value

remove_DataRefreshing(DataRefreshing)

Declaration
public virtual void remove_DataRefreshing(DataRefreshing value)
Parameters
Type Name Description
DataRefreshing value

remove_Expanded(Expanded)

Declaration
public virtual void remove_Expanded(Expanded value)
Parameters
Type Name Description
Expanded value

remove_Expanding(Expanding)

Declaration
public virtual void remove_Expanding(Expanding value)
Parameters
Type Name Description
Expanding value

remove_FilterActionCompleted(FilterActionCompletedEventHandler)

Declaration
public virtual void remove_FilterActionCompleted(FilterActionCompletedEventHandler value)
Parameters
Type Name Description
FilterActionCompletedEventHandler value

remove_GroupingBarLoaded(GroupingBarLoaded)

Declaration
public virtual void remove_GroupingBarLoaded(GroupingBarLoaded value)
Parameters
Type Name Description
GroupingBarLoaded value

remove_HyperlinkCellClick(HyperlinkCellClick)

Declaration
public virtual void remove_HyperlinkCellClick(HyperlinkCellClick value)
Parameters
Type Name Description
HyperlinkCellClick value

remove_ItemSourceChanged(ItemSourceChanged)

Declaration
public virtual void remove_ItemSourceChanged(ItemSourceChanged value)
Parameters
Type Name Description
ItemSourceChanged value

remove_SelectionChanged(SelectionChanged)

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

remove_SortBegin(SortBegin)

Declaration
public virtual void remove_SortBegin(SortBegin value)
Parameters
Type Name Description
SortBegin value

remove_SortCompleted(SortCompleted)

Declaration
public virtual void remove_SortCompleted(SortCompleted value)
Parameters
Type Name Description
SortCompleted value

ResetCoveredCells()

Resets the covered cell ranges in the InternalGrid, to match the covered cells in the PivotEngine.

Declaration
public void ResetCoveredCells()

ResetPivotData()

Resets the Pivot data (resets the PivotEngine, PivotRows, PivotColumns, PivotFields, PivotCalculations and ItemsSource).

Declaration
public void ResetPivotData()

Serialize()

Serializes some specific properties in PivotGrid control.

Declaration
public void Serialize()

Serialize(String)

Serializes the specific properties in PivotGrid control and saves it with the specified file name.

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

SerializedXmlString()

Serializes some specific properties in PivotGrid control into string format.

Declaration
public string SerializedXmlString()
Returns
Type
System.String

ShowPivotValueChooserCanExecute(Object, CanExecuteRoutedEventArgs)

Can execute the PivotValueChooser visibility(show/hide) operation for the given command.

Declaration
public void ShowPivotValueChooserCanExecute(object sender, CanExecuteRoutedEventArgs e)
Parameters
Type Name Description
System.Object sender

The PivotValueChooser.
System.Windows.Input.CanExecuteRoutedEventArgs e

The event argument.

ShowPivotValueChooserExecuted(Object, ExecutedRoutedEventArgs)

Executes the PivotValueChooser visibility(show/hide) operation for the given command.

Declaration
public void ShowPivotValueChooserExecuted(object sender, ExecutedRoutedEventArgs e)
Parameters
Type Name Description
System.Object sender

The PivotValueChooser.
System.Windows.Input.ExecutedRoutedEventArgs e

The event argument.

ShowPrintPreview(DataTemplate, DataTemplate, String, Window)

Shows the print preview window with templates for header, footer and user-defined title.

Declaration
public void ShowPrintPreview(DataTemplate headerTemplate, DataTemplate footerTemplate, string title, Window win)
Parameters
Type Name Description
System.Windows.DataTemplate headerTemplate

DateTemplate for Header.
System.Windows.DataTemplate footerTemplate

DataTemplate for Footer.
System.String title

Title for PrintPreview Window.
System.Windows.Window win

Type of Window.

ShowPrintPreview(DataTemplate, DataTemplate, Window)

Shows the print preview window with templates for header, footer and default title.

Declaration
public void ShowPrintPreview(DataTemplate headerTemplate, DataTemplate footerTemplate, Window win)
Parameters
Type Name Description
System.Windows.DataTemplate headerTemplate

DateTemplate for header.
System.Windows.DataTemplate footerTemplate

DateTemplate for footer.
System.Windows.Window win

Type of Window.

ShowPrintPreview(Window)

Shows the print preview window with empty template and default title.

Declaration
public void ShowPrintPreview(Window Win)
Parameters
Type Name Description
System.Windows.Window Win

Gets the type of the window.

SortPivotItem(Int32, ListSortDirection, Boolean, PropertyDescriptor)

Sorts a PivotItem specified by the index and "isRowPivot" settings.

Declaration
public void SortPivotItem(int index, ListSortDirection sortDir, bool isRowPivot, PropertyDescriptor descriptor)
Parameters
Type Name Description
System.Int32 index

The index of the PivotItem in its parent collection.
System.ComponentModel.ListSortDirection sortDir

The sort order.
System.Boolean isRowPivot

Passes true, if the PivotItem is a row pivot and false, if it is a column pivot.
System.ComponentModel.PropertyDescriptor descriptor

Sorts the PivotItem based on PropertyDescriptor supplied.

Events

Collapsed

An event that notifies after collapse operation.

Declaration
public virtual event Collapsed Collapsed
Event Type
Type
Collapsed

Collapsing

An event that notifies before collapse operation.

Declaration
public virtual event Collapsing Collapsing
Event Type
Type
Collapsing

DataRefreshed

An event that notifies after refreshing the data.

Declaration
public virtual event DataRefreshed DataRefreshed
Event Type
Type
DataRefreshed

DataRefreshing

An event that notifies before refreshing the data.

Declaration
public virtual event DataRefreshing DataRefreshing
Event Type
Type
DataRefreshing

Expanded

An event that notifies after expand operation.

Declaration
public virtual event Expanded Expanded
Event Type
Type
Expanded

Expanding

An event that notifies before expand operation.

Declaration
public virtual event Expanding Expanding
Event Type
Type
Expanding

FilterActionCompleted

An event that notifies on the completion of filter action.

Declaration
public virtual event FilterActionCompletedEventHandler FilterActionCompleted
Event Type
Type
FilterActionCompletedEventHandler

GroupingBarLoaded

An event that notifies after loading the GroupingBar.

Declaration
public virtual event GroupingBarLoaded GroupingBarLoaded
Event Type
Type
GroupingBarLoaded

HyperlinkCellClick

An event that notifies click action on hyperlink cell.

Declaration
public virtual event HyperlinkCellClick HyperlinkCellClick
Event Type
Type
HyperlinkCellClick

ItemSourceChanged

This event will fire whenever the ItemSource of the PivotGrid is changed.

Declaration
public virtual event ItemSourceChanged ItemSourceChanged
Event Type
Type
ItemSourceChanged

LoadInBackgroundCompleted

Occurs when LoadInBackGround operations completed.

Declaration
public event EventHandler LoadInBackgroundCompleted
Event Type
Type
System.EventHandler

OnDemandCalculationsCompleted

Occurs when EnableOnDemandCalculation operations completed.

Declaration
public event EventHandler OnDemandCalculationsCompleted
Event Type
Type
System.EventHandler

SelectionChanged

This event will fire whenever the PivotGrid selection is changed.

Declaration
public virtual event SelectionChanged SelectionChanged
Event Type
Type
SelectionChanged

ShowDisabledGroupBackgroundPropertyChanged

An event that notifies whenever "ShowDisabledGroupBackGround" property value changes.

Declaration
public virtual event EventHandler ShowDisabledGroupBackgroundPropertyChanged
Event Type
Type
System.EventHandler

SortBegin

An event that notifies before starting the sort action.

Declaration
public virtual event SortBegin SortBegin
Event Type
Type
SortBegin

SortCompleted

An event that notifies after sort action is completed.

Declaration
public virtual event SortCompleted SortCompleted
Event Type
Type
SortCompleted

Implements

System.IDisposable