This section provides you with useful information about task-based procedures on handling events for the xamPivotGrid™ control.
This topic is organized as follows:
To begin, please read the Getting Started with xamPivotGrid and the Binding Data topics in order to get familiar with the xamPivotGrid control and its supported data sources.
In the xamPivotGrid control, events are categorized into two groups based on what object is raising them.
Table 1 – Event Groups in the xamPivotGrid
The xamPivotGrid control has a number of eventsand a complete list of events is provided in the events section of the API Overview of the xamPivotGrid. The following paragraphs highlight the most often used events.
Table 2 – Event Exposed by the xamPivotGrid control
*This event is also available for the XamPivotDataSelector class.
The following code snippet applies a style to the cells in column number two (if it is not null) when cells are loaded by handling the CellControlAttached event.
In Visual Basic:
Imports Infragistics.Controls.Grids
...
AddHandler Me.PivotGrid.DataSource.CellControlAttached, AddressOf OnPivotGridCellControlAttached
...
Private Sub OnPivotGridCellControlAttached( ByVal sender As Object, ByVal e As PivotCellControlAttachedEventArgs)
If Me.PivotGrid.DataColumns.IndexOf(e.Cell.DataColumn) = 1 Then
e.Cell.Style = TryCast(Me.Resources("FormattedCellStyle"), System.Windows.Style)
End If
End Sub
In C#:
using Infragistics.Controls.Grids;
...
this.PivotGrid.CellControlAttached += OnPivotGridCellControlAttached;
...
void OnPivotGridCellControlAttached(object sender, PivotCellControlAttachedEventArgs e)
{
if (this.PivotGrid.DataColumns.IndexOf(e.Cell.DataColumn) == 1)
{
e.Cell.Style = this.Resources["FormattedCellStyle"] as System.Windows.Style;
}
}
Besides implementing custom logic when these events are raised, you can also disable some of the grid functionalities using these events. The following snippet disables header expansion, cancels column resizing for the second column, and displays a message when a column is sorted.
In Visual Basic:
Imports Infragistics.Controls.Grids
...
AddHandler Me.PivotGrid.AxisExpansionChanging, AddressOf OnPivotGridAxisExpansionChanging
AddHandler Me.PivotGrid.ColumnResizing, AddressOf OnPivotGridColumnResizing
AddHandler Me.PpivotGrid.ColumnSorted, AddressOf OnPivotGridColumnSorted
...
Private Sub AxisExpansionChanging(ByVal sender As Object, ByVal e As CancellableAxisEventArgs)
e.Cancel = True
End Sub
Private Sub ColumnResizing(ByVal sender As Object, ByVal e As CancellableColumnResizingEventArgs)
If e.Columns.Contains(Me.pivotGrid.DataColumns(1)) Then
e.Cancel = True
End If
End Sub
Private Sub ColumnSorted(ByVal sender As Object, ByVal e As PivotSortedColumnEventArgs)
MessageBox.Show(e.Column.Key + " was sorted.")
End Sub
In C#:
using Infragistics.Controls.Grids;
...
this.PivotGrid.AxisExpansionChanging += OnPivotGridAxisExpansionChanging;
this.PivotGrid.ColumnResizing += OnPivotGridColumnResizing;
this.PivotGrid.ColumnSorted += OnPivotGridColumnSorted;
...
void OnPivotGridColumnResizing(object sender, PivotCancellableColumnResizingEventArgs e)
{
if (e.Columns.Contains(this.pivotGrid.DataColumns[1]))
{
e.Cancel = true;
}
}
void OnPivotGridColumnSorted(object sender, PivotSortedColumnEventArgs e)
{
System.Windows.MessageBox.Show(e.Column.Key + " was sorted.");
}
void OnPivotGridAxisExpansionChanging(object sender, PivotCancellableAxisEventArgs e)
{
e.Cancel = true;
}
The xamPivotGrid control’s DataSource exposes only a few events of the IOlapViewModel interface and they are all related to loading the data. For a complete list refer to the IOlapViewModel interface in the Infragistics.WPF.Olap NuGet package section of the API Reference Guide.
Table 3 – Event Exposed by the IOlapViewModel interface
The Load events are useful if you want to know when the DataSource has finished initializing the dimensions, measures, cubes or members, data load progress indicators and styling based on different cubes among other applications.
The following code shows how to apply a style when the cube is loaded and then display a message every time the result is changed.
In Visual Basic:
Imports Infragistics.Controls.Grids
...
AddHandler Me.pivotGrid.DataSource.LoadCubesCompleted, AddressOf OnDataSourceLoadCubesCompleted
AddHandler Me.pivotGrid.DataSource.ResultChanged, AddressOf OnDataSourceResultChanged
...
Private Sub OnDataSourceLoadCubesCompleted(ByVal sender As Object, ByVal e As LoadCubesCompletedEventArgs)
Me.pivotGrid.Style = Me.Resources("PivotGridStyle")
End Sub
Private Sub OnDataSourceResultChanged(ByVal sender As Object, ByVal e As AsyncCompletedEventArgs)
System.Windows.MessageBox.Show("The result is changed!")
End Sub
In C#:
using Infragistics.Controls.Grids;
...
this.PivotGrid.DataSource.LoadCubesCompleted += OnDataSourceLoadCubesCompleted;
this.PivotGrid.DataSource.ResultChanged += OnDataSourceResultChanged;
...
void OnDataSourceResultChanged(object sender, System.ComponentModel.AsyncCompletedEventArgs e)
{
System.Windows.MessageBox.Show("The result is changed!");
}
void OnDataSourceLoadCubesCompleted(object sender, LoadCubesCompletedEventArgs e)
{
this.PivotGrid.Style = this.Resources["PivotGridStyle"] as System.Windows.Style;
}