Class PivotGridControlBase

Represents the functionality of a pivot table, which is a data summarization tool that automatically sorts, count and total the table data and represents in cross tabular format.

Inheritance
System.Object
BaseControl
ScrollControl
GridControlBase
GridControlBaseImp
PivotGridControlBase
Inherited Members
Namespace: Syncfusion.Windows.Forms.PivotAnalysis
Assembly: Syncfusion.PivotAnalysis.Windows.dll
Syntax
public class PivotGridControlBase : GridControlBaseImp, IDisposable, ICancelModeProvider, ISplitterPaneSupport, IScrollBarWrapperContainer, ISupportUpdating, ISupportIntelliMouse, IQueryFocusInside, INonClientPaintingSupport, IThemedControl, ICreateNewWindow, IGridModelSource, IGridWindowlessSite, IGridWindowlessObject, IFindParentForm, IThemeProvider, IVisualStyle, IPivotControl
Remarks

To use this control, you must assign some IList object to the ItemSource property. The IList object must have public properties, which you want to use it in the pivot table. To represent the data in cross tabular format, you need to specify the pivot information in
PivotRows, PivotColumns and PivotCalculations properties.

Constructors

PivotGridControlBase()

Initializes a new instance of the PivotGridControlBase class.

Declaration
public PivotGridControlBase()

PivotGridControlBase(GridModel)

Initializes a new instance of the PivotGridControlBase class with the specified GridModel.

Declaration
public PivotGridControlBase(GridModel model)
Parameters
Type Name Description
GridModel model

The instance of GridModel class.

Fields

PivotFilters

Gets or sets the collection of FilterExpression.

Declaration
public ObservableCollection<FilterExpression> PivotFilters
Field Value
Type Description
System.Collections.ObjectModel.ObservableCollection<FilterExpression>

Properties

AllowedFields

Gets a collection of FieldInfo instances that hold field names which are visible in the engine.

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

The names can be either public property names of the underlying data objects, or they can be expression field. 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 pivot table. 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.

AllowFiltering

Gets or sets a value indicating whether to enable or disable the filtering.

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

true if the filtering is enabled; otherwise, false. The default value istrue.

AllowRowPivotFiltering

Gets or sets a value indicating whether the filtering option is enabled for RowPivotsOnly mode.

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

true if the filtering is enabled; otherwise, false. The default value is true.

AllowSelection

Gets or sets a value indicating whether to allow selection of cells as in Excel or not.

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

true if the selection is enabled; otherwise, false. The default value is false.

AllowSorting

Gets or sets a value indicating whether to enable or disable the sorting.

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

true if the sorting is enabled; otherwise, false. The default value istrue.

ConditionalFormats

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

CustomizeSystemTheme

Gets or sets a value indicating whether the system theme should be customized or not.

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

trueif the system theme is customized; otherwise, false. The default value is false.

DeferLayoutUpdate

Gets or sets a value indicating whether the layout should be updated immediately for dynamic change in PivotGrid's information or it should wait for a Refresh() call.

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

true if the layout waits for the Refresh() call; otherwise, false. The default value is false.

FilterArea

Gets or sets the FilterBar for FilterArea.

Declaration
public FilterBar FilterArea { get; set; }
Property Value
Type Description
FilterBar

Filters

Gets the collection of FilterExpression.

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

FreezeHeaders

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

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

true if the headers are frozen; otherwise, false. The default value is false.

GridColumnList

Gets or sets the value of grid column list.

Declaration
public GridList GridColumnList { get; set; }
Property Value
Type Description
GridList

GridFilterList

Gets or sets the value of filter list.

Declaration
public GridList GridFilterList { get; set; }
Property Value
Type Description
GridList

GridRowList

Gets or sets the value of grid row list.

Declaration
public GridList GridRowList { get; set; }
Property Value
Type Description
GridList

GridValueList

Gets or sets the value of GridValueList.

Declaration
public GridList GridValueList { get; set; }
Property Value
Type Description
GridList

GridVisualStyles

Gets or sets the VisualStyles (skins) like Office2010, Office2007, Office2003.

Declaration
public GridVisualStyles GridVisualStyles { get; set; }
Property Value
Type Description
GridVisualStyles
Examples

This example shows how to use the GridVisualStyles property.

// Sets the Visual style for the pivot grid. Here "Metro" theme is set.
this.pivotGridControl1.GridVisualStyles = Syncfusion.Windows.Forms.GridVisualStyles.Metro;
' Sets the Visual style for the pivot grid. Here "Metro" theme is set.
Me.pivotGridControl1.GridVisualStyles = Syncfusion.Windows.Forms.GridVisualStyles.Metro

GridVisualStylesDrawing

Gets or sets the VisualStylesDrawing object.

Declaration
public IVisualStylesDrawing GridVisualStylesDrawing { get; set; }
Property Value
Type Description
IVisualStylesDrawing

GroupDropArea

Gets or sets the value of GroupBar.

Declaration
public GroupBar GroupDropArea { get; set; }
Property Value
Type Description
GroupBar

IsDynamicData

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

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

true if dynamic data is set; otherwise, false. The default value isfalse.

IsExternalEngine

Gets or sets a value indicating whether the engine of this control is internally created or supplied from external source.

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

true if the external engine is set; otherwise, false. The default value is false.

ItemSource

Gets or sets source of data for this pivot table. This object should be either an IEnumerable list, or a DataTable.

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

This example shows how to use the ItemSource property.

// Adding ItemSource to the pivot grid. Here "ProdutSales" is the datasource assigned to the grid.
this.pivotGridControl1.ItemSource = ProductSales.GetSalesData();
' Adding ItemSource to the pivot grid. Here "ProdutSales" is the datasource assigned to the grid.
Me.pivotGridControl1.ItemSource = ProductSales.GetSalesData()

MetroStyle

Gets or sets the value of metro style.

Declaration
public MetroColors MetroStyle { get; set; }
Property Value
Type Description
MetroColors

NewRuleConditionalFormat

Gets or sets the collection of PivotGridNewRuleConditionalFormat.

Declaration
public ObservableCollection<PivotGridNewRuleConditionalFormat> NewRuleConditionalFormat { get; set; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<PivotGridNewRuleConditionalFormat>
Examples

This example shows how to use the NewRuleConditionalFormat property.

void TableControl_CellClick(object sender, Syncfusion.Windows.Forms.Grid.GridCellClickEventArgs e)
{
   // Initializing a new rule.
   NewRuleConditionalFormat newRule1 = new NewRuleConditionalFormat();
   // Setting the condition types and predicate types.
   ConditionalFormat form = new ConditionalFormat();
   form.ConditionType = PivotGridDataConditionType.Equals;
   form.PredicateType = PredicateType.Or;
   form.StartValue = 5;
   form.EndValue = 555;
   newRule1.Conditions.Add(form);
   // Formatting is done if the condition gets satisfied.
   PivotGridNewRuleConditionalFormat newRuleFormat1 = new PivotGridNewRuleConditionalFormat();
   newRuleFormat1.NewRuleCollections.Add(newRule1);
   // Sample condition.
   if (form.StartValue < e.RowIndex)
   {
       this.pivotGridControl1.TableModel[e.RowIndex, e.ColIndex].TextColor = Color.Red;
   }
   // The new rule gets associated with the pivot grid.
   this.pivotGridControl1.TableControl.NewRuleConditionalFormat.Add(newRuleFormat1);
}
Private Sub TableControl_CellClick(ByVal sender As Object, ByVal e As Syncfusion.Windows.Forms.Grid.GridCellClickEventArgs)
   ' Initializing a new rule.
   Dim newRule1 As New NewRuleConditionalFormat()
   ' Setting the condition types and predicate types.
   Dim form As New ConditionalFormat()
   form.ConditionType = PivotGridDataConditionType.Equals
   form.PredicateType = PredicateType.Or
   form.StartValue = 5
   form.EndValue = 555
   newRule1.Conditions.Add(form)
   ' Formatting is done if the condition gets satisfied.
   Dim newRuleFormat1 As New PivotGridNewRuleConditionalFormat()
   newRuleFormat1.NewRuleCollections.Add(newRule1)
   ' Sample condition.
   If form.StartValue<e.RowIndex Then
      Me.pivotGridControl1.TableModel(e.RowIndex, e.ColIndex).TextColor = Color.Red
   End If
   ' The new rule gets associated with the pivot grid.
   Me.pivotGridControl1.TableControl.NewRuleConditionalFormat.Add(newRuleFormat1)
   End Sub

PivotCalculations

Gets the collection of PivotComputationInfo.

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

This example shows how to use the PivotCalculations property.

// Adding PivotCalculations to the pivot grid.
this.pivotGridControl1.PivotCalculations.Add(new PivotComputationInfo { FieldName = "Amount", Format = "#,##0", SummaryType = SummaryType.DoubleTotalSum});
' Adding PivotCalculations to the pivot grid.
Me.pivotGridControl1.PivotCalculations.Add(New PivotComputationInfo With {.FieldName = "Amount", .Format = "#,##0", .SummaryType = SummaryType.DoubleTotalSum})

PivotColumns

Gets the collection of PivotItem.

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

This example shows how to use the PivotColumns property. Here "Country" is the field's mapping name and "Total" is the header.

// Adding PivotColumns to the pivot grid.
this.pivotGridControl1.PivotColumns.Add(new PivotItem { FieldMappingName = "Country", TotalHeader = "Total" });
' Adding PivotColumns to the pivot grid. Here "Country" is the field's mapping name and "Total" is the header.
Me.pivotGridControl1.PivotColumns.Add(New PivotItem With {.FieldMappingName = "Country", .TotalHeader = "Total"})

PivotEngine

Gets or sets the PivotEngine.

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

PivotFields

Gets the collection of PivotItem.

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

PivotRows

Gets the collection of PivotItem.

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

This example shows how to use the PivotRows property.

// Adding PivotRows to the pivot grid. Here "Product" is the field's mapping name and "Total" is the header.
this.pivotGridControl1.PivotRows.Add(new PivotItem { FieldMappingName = "Product", TotalHeader = "Total" });
' Adding PivotRows to the pivot grid. Here "Product" is the field's mapping name and "Total" is the header.
Me.pivotGridControl1.PivotRows.Add(New PivotItem With {.FieldMappingName = "Product", .TotalHeader = "Total"})

PivotTableFieldList

Gets or sets the value of field list in the pivot table.

Declaration
public GridList PivotTableFieldList { get; set; }
Property Value
Type Description
GridList

RowGroupDropArea

Gets or sets the value of Row GroupBar.

Declaration
public RowGroupBar RowGroupDropArea { get; set; }
Property Value
Type Description
RowGroupBar

ShowCalculationsAsColumns

Gets or sets a value indicating whether the calculations should be appeared as columns or not.

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

true if the calculations are shown as columns; otherwise, false. The default value istrue.

ShowGrandTotals

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

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

true if the calculations are computed by the engine; otherwise, false. The default value is true.

ShowGroupBar

Gets or sets a value indicating whether to enable or disable the grouping bar.

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

true if the grouping bar is enabled; otherwise, false. The default value is false.

ShowSubTotals

Gets or sets a value indicating whether the subtotal values should be shown or not.

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

truethe subtotal values is shown; otherwise, false. The default value is true.

Methods

CellStyle_PropertyChanged(Object, PropertyChangedEventArgs)

Handles the PropertyChanged event of the CellStyle control.

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.

CollapseAllColumnGroups()

Collapses all the grouped columns.

Declaration
public void CollapseAllColumnGroups()
Examples

This example shows how to collapse all column groups.

// Collapse all the column groups.
this.pivotGridControl1.TableControl.CollapseAllColumnGroups();
' Collapse all the column groups.
Me.pivotGridControl1.TableControl.CollapseAllColumnGroups()

CollapseAllGroups()

Collapses all the groups.

Declaration
public void CollapseAllGroups()
Examples

This example shows how to collapse all the groups.

// Collapse all the groups either it may be row group or column group.
this.pivotGridControl1.TableControl.CollapseAllGroups();
' Collapse all the groups either it may be row group or column group.
Me.pivotGridControl1.TableControl.CollapseAllGroups()

CollapseAllRowGroups()

Collapses all the grouped rows.

Declaration
public void CollapseAllRowGroups()
Examples

This example shows how to collapse all the row groups.

// Collapse all the row groups.
this.pivotGridControl1.TableControl.CollapseAllRowGroups();
' Collapse all the row groups.
Me.pivotGridControl1.TableControl.CollapseAllRowGroups()

CollapseColumn(List<String>)

Collapse the Columns for the specified 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 Expander headers.
Examples

This example shows how to collapse a list of columns.

// Collapses a list of columns. Here "Total", "StateId", "Amount" are all mapping names.
List<string> collumnColapsed = new List<string>();
// Columns to be collapsed.
collumnColapsed.Add("Total");
collumnColapsed.Add("StateId");
collumnColapsed.Add("Amount");
this.pivotGridControl1.TableControl.CollapseColumn(collumnColapsed);
' Collapses a list of columns. Here "Total", "StateId", "Amount" are all mapping names.
Dim collumnColapsed As New List(Of String)()
' Columns to be collapsed.
collumnColapsed.Add("Total")
collumnColapsed.Add("StateId")
collumnColapsed.Add("Amount")
Me.pivotGridControl1.TableControl.CollapseColumn(collumnColapsed)

CollapseColumn(String)

Collapses the column for the specified unique text.

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

An unique way of representation for the header cell which has a parent cell UniqueText.
Examples

This example shows how to collapse a column with a specified column header-mapping name.

// Collapse the specified column. Here "Total" is column mapping name.
this.pivotGridControl1.TableControl.CollapseColumn("Total");
' Collapse the specified column. Here "Total" is column mapping name.
Me.pivotGridControl1.TableControl.CollapseColumn("Total")

CollapseRow(List<String>)

Collapse the rows for the specified 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 Expander headers.
Examples

This example shows how to collapse a list of rows.

// Collapses a list of rows.  Here "Total", "StateId", "Amount" are all mapping names.
List<string> rowColapsed = new List<string>();
rowColapsed.Add("Total");
rowColapsed.Add("StateId");
rowColapsed.Add("Amount");
this.pivotGridControl1.TableControl.CollapseRow(rowColapsed);
' Collapses a list of rows.  Here "Total", "StateId", "Amount" are all mapping names.
Dim rowColapsed As New List(Of String)()
rowColapsed.Add("Total")
rowColapsed.Add("StateId")
rowColapsed.Add("Amount")
Me.pivotGridControl1.TableControl.CollapseRow(rowColapsed)

CollapseRow(String)

Collapses the row for the specified unique text.

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

An unique way of representation for the header cell which has a parent cell UniqueText.
Examples

This example shows how to collapse the specific row.

// Collapse the specified row. Here "Amount" is a mapping name.
this.pivotGridControl1.TableControl.CollapseRow("Amount");
' Collapse the specified row. Here "Amount" is a mapping name.
Me.pivotGridControl1.TableControl.CollapseRow("Amount")

ExpandAllColumnGroups()

Expands all the grouped columns.

Declaration
public void ExpandAllColumnGroups()
Examples

This example shows how to expand all the column groups.

// Expands all the columns groups.
this.pivotGridControl1.TableControl.ExpandAllColumnGroups();
' Expands all the columns groups.
Me.pivotGridControl1.TableControl.ExpandAllColumnGroups()

ExpandAllGroups()

Expands all the groups.

Declaration
public void ExpandAllGroups()
Examples

This example shows how to expand all groups.

// Expands all the groups either it may be column or row.
this.pivotGridControl1.TableControl.ExpandAllGroups();
' Expands all the groups either it may be column or row.
Me.pivotGridControl1.TableControl.ExpandAllGroups()

ExpandAllRowGroups()

Expands all the grouped rows.

Declaration
public void ExpandAllRowGroups()
Examples

This example shows how to expand all the row groups.

// Expands all the row groups.
this.pivotGridControl1.TableControl.ExpandAllRowGroups();
' Expands all the row groups.
Me.pivotGridControl1.TableControl.ExpandAllRowGroups()

ExpandColumn(List<String>)

Expand the Columns for 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 Expander headers.
Examples

This example shows how to expand the list of columns.

// Expands all the columns. Here "Total", "StateId", "Amount" are all mapping names.
List<string> myExpandingColumns = new List<string>();
myExpandingColumns.Add("Total");
myExpandingColumns.Add("StateId");
myExpandingColumns.Add("Amount");
this.pivotGridControl1.TableControl.ExpandColumn(myExpandingColumns);
' Expands all the columns. Here "Total", "StateId", "Amount" are all mapping names.
Dim myExpandingColumns As New List(Of String)()
myExpandingColumns.Add("Total")
myExpandingColumns.Add("StateId")
myExpandingColumns.Add("Amount")
Me.pivotGridControl1.TableControl.ExpandColumn(myExpandingColumns)

ExpandColumn(String)

Expands the column for the specified unique text.

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

An unique way of representation for the header cell which has a parent cell UniqueText.
Examples

This example shows how to expand a specific column with the given column mapping-name.

// Expand the specific column with the given column mapping name.
this.pivotGridControl1.TableControl.ExpandColumn("Amount");
' Expand the specific column with the given column mapping name.
Me.pivotGridControl1.TableControl.ExpandColumn("Amount")

ExpandRow(List<String>)

Expand the rows for 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 Expander headers.
Examples

This example shows how to expand a list of rows.

// Expands all the rows. Here "Total", "StateId", "Amount" are all mapping names.
List<string> myExpandingRows = new List<string>();
myExpandingRows.Add("Total");
myExpandingRows.Add("StateId");
myExpandingRows.Add("Amount");
this.pivotGridControl1.TableControl.ExpandRow(myExpandingRows);
' Expands all the rows. Here "Total", "StateId", "Amount" are all mapping names.
Dim myExpandingRows As New List(Of String)()
myExpandingRows.Add("Total")
myExpandingRows.Add("StateId")
myExpandingRows.Add("Amount")
Me.pivotGridControl1.TableControl.ExpandRow(myExpandingRows)

ExpandRow(String)

Expands the row for the specified unique text.

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

An unique way of representation for the header cell which has a parent cell UniqueText.
Examples

This example shows how to expand a specific row.

// Expand the specific row. Here "Total" is a mapping name.
this.pivotGridControl1.TableControl.ExpandRow("Total");
' Expand the specific row. Here "Total" is a mapping name.
Me.pivotGridControl1.TableControl.ExpandRow("Total")

GroupBarSize()

Calculates the group bar size.

Declaration
public void GroupBarSize()

InvalidateCells()

Invalidates the cells.

Declaration
public void InvalidateCells()

InvalidateCells(GridRangeInfo)

Invalidates a range of cells.

Declaration
public void InvalidateCells(GridRangeInfo range)
Parameters
Type Name Description
GridRangeInfo range

range to be invalidated

Model_SelectionChanging(Object, GridSelectionChangingEventArgs)

Occurs before selecting a range of cells.

Declaration
protected void Model_SelectionChanging(object sender, GridSelectionChangingEventArgs e)
Parameters
Type Name Description
System.Object sender

The source of the event.
GridSelectionChangingEventArgs e

The GridSelectionChangingEventArgs that contains the event data.

OnCreateControl()

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

Declaration
protected override void OnCreateControl()
Overrides

OnDrawCell(GridDrawCellEventArgs)

Overridden to raises the cell drawn event.

Declaration
protected override void OnDrawCell(GridDrawCellEventArgs e)
Parameters
Type Name Description
GridDrawCellEventArgs e

The GridDrawCellEventArgs that contains the event data.
Overrides

OnRightToLeftChanged(EventArgs)

Overridden to handle the PivotGridControl changed to RTL mode.

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

TheSystem.EventArgs that contains the event data.
Overrides

OnTouchPan(Point, Boolean)

Handles the touch selection or scrolling operations

Declaration
protected override bool OnTouchPan(Point currentTouchPoint, bool isSwipeScroll)
Parameters
Type Name Description
System.Drawing.Point currentTouchPoint

Current touch position
System.Boolean isSwipeScroll

Used to check the swipe scrolling operation occurs in the control. When isSwipeScroll is true then cancel the operations while doing selection operations.
Returns
Type Description
System.Boolean

Retruns false if do the selection process. Otherwise return true
Overrides

OnTouchPanBegin(Point)

Initialize the touch selection operation or touch scrolling operations.

Declaration
protected override bool OnTouchPanBegin(Point touchBeginPoint)
Parameters
Type Name Description
System.Drawing.Point touchBeginPoint

Touch position when panning operation start
Returns
Type Description
System.Boolean

Returns false when do other operations like selection
Overrides

OnTouchPanEnd(Point)

Call the mouse up method when selection process done, otherwise call the base method to end the panning operation.

Declaration
protected override bool OnTouchPanEnd(Point touchEndPoint)
Parameters
Type Name Description
System.Drawing.Point touchEndPoint

touch control end point
Returns
Type Description
System.Boolean

Return false when resizing or selection or dragging process done
Overrides

PivotGridControlBase_CurrentCellStartEditing(Object, CancelEventArgs)

Occurs before the current cell switches into edit mode.

Declaration
protected void PivotGridControlBase_CurrentCellStartEditing(object sender, CancelEventArgs e)
Parameters
Type Name Description
System.Object sender

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

The that contains the event data.

PopulateDefaultPropertyFields()

Populates the default property fields.

Declaration
public void PopulateDefaultPropertyFields()

RaiseOnCollapsing(CollapsingEventArgs, GridStyleInfo)

Raises the OnCollapsing Event.

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

The CollapsingEventArgs instance containing the event data.
GridStyleInfo styleInfo

Stores the information about cell.

RaiseOnExpanding(ExpandingEventArgs, PivotCellInfo)

Raises the OnExpanding event.

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

The ExpandingEventArgs instance containing the event data.
PivotCellInfo OriginalCell

Information about specific cell.

Refresh(Boolean)

Refreshes the layout of PivotGridControlBase.

Declaration
public void Refresh(bool shouldPopulateEngine)
Parameters
Type Name Description
System.Boolean shouldPopulateEngine

It will repopulate the PivotEngine if True.

ResetPivotData()

Resets the pivot data (resets the pivot engine, pivot rows, pivot columns, pivot fields, pivot calculations and items source).

Declaration
public void ResetPivotData()
Examples

This example shows how to reset the data displayed in the pivot grid table.

' Resets the data displayed in the pivot grid.
Me.pivotGridControl1.TableControl.ResetPivotData()
' Resets the data displayed in the pivot grid.
Me.pivotGridControl1.TableControl.ResetPivotData()

SynchronizeCalculations(NotifyCollectionChangedEventArgs)

To synchronize the calculation items with the pivot grid control.

Declaration
public void SynchronizeCalculations(NotifyCollectionChangedEventArgs e)
Parameters
Type Name Description
System.Collections.Specialized.NotifyCollectionChangedEventArgs e

The System.Collections.Specialized.NotifyCollectionChangedEventArgs that contains the event data.

SynchronizeFilters(NotifyCollectionChangedEventArgs)

Declaration
public void SynchronizeFilters(NotifyCollectionChangedEventArgs e)
Parameters
Type Name Description
System.Collections.Specialized.NotifyCollectionChangedEventArgs e

SynchronizePivotItems(NotifyCollectionChangedEventArgs, Boolean)

To synchronize the column or row items with the pivot grid control.

Declaration
public void SynchronizePivotItems(NotifyCollectionChangedEventArgs e, bool isRow)
Parameters
Type Name Description
System.Collections.Specialized.NotifyCollectionChangedEventArgs e

The System.Collections.Specialized.NotifyCollectionChangedEventArgs that contains the event data.
System.Boolean isRow

Represents the boolean value.

Events

Collapsed

Used to handle the Collapsed event

Declaration
public virtual event Collapsed Collapsed
Event Type
Type Description
Collapsed

Collapsing

Used to handle the Collapsing event

Declaration
public virtual event Collapsing Collapsing
Event Type
Type Description
Collapsing

DataRefreshed

Used to handle the DataRefreshed event

Declaration
public virtual event DataRefreshed DataRefreshed
Event Type
Type Description
DataRefreshed

DataRefreshing

Used to handle the DataRefreshing event

Declaration
public virtual event DataRefreshing DataRefreshing
Event Type
Type Description
DataRefreshing

Expanded

Used to handle the Expanded event

Declaration
public virtual event Expanded Expanded
Event Type
Type Description
Expanded

Expanding

Used to handle the Expanding event

Declaration
public virtual event Expanding Expanding
Event Type
Type Description
Expanding

HyperlinkCellClick

Used to handle the HyperlinkCellClick event

Declaration
public virtual event HyperlinkCellClick HyperlinkCellClick
Event Type
Type Description
HyperlinkCellClick

ItemSourceChanged

Occurs when the ItemSource property value gets changed.

Declaration
public event ItemSourceChangedEventHandler ItemSourceChanged
Event Type
Type Description
ItemSourceChangedEventHandler

SelectionChanged

Occurs when the SelectedItems instance value gets changed.

Declaration
public virtual event SelectionChanged SelectionChanged
Event Type
Type Description
SelectionChanged

ShowDisabledGroupBackgroundPropertyChanged

Used to handle the event that has no event data.

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

Implements

System.IDisposable