PivotFieldValueEventArgs Class

Serves as a base for the classes that provide data for the events which are used to customize column and row headers.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v18.1.dll

Declaration

C#

public class PivotFieldValueEventArgs :
    PivotFieldValueEventArgsBase<PivotGridField>

VB.NET

Public Class PivotFieldValueEventArgs
    Inherits PivotFieldValueEventArgsBase(Of PivotGridField)

Related API Members

The following members accept/return PivotFieldValueEventArgs objects:

• PivotChartDataSourceRow.ColumnValueInfo
• PivotChartDataSourceRow.RowValueInfo
• PivotCustomChartDataSourceDataEventArgs.FieldValueInfo

Related API Members

PivotFieldValueEventArgs is the data class for the following events:

• PivotGridControl.FieldValueCollapsed
• PivotGridControl.FieldValueExpanded
• PivotGridControl.FieldValueNotExpanded

Remarks

The PivotFieldValueEventArgs class serves as a base for the PivotFieldDisplayTextEventArgs and PivotFieldImageIndexEventArgs classes that provide data for the PivotGridControl.FieldValueDisplayText and PivotGridControl.FieldValueImageIndex events, respectively.

The type of the currently processed header is determined by the PivotFieldValueEventArgsBase<T>.ValueType property. If the header is a field value or total header you can get the value of the corresponding field via the PivotFieldValueEventArgsBase<T>.Value property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PivotFieldValueEventArgs class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-sort-a-xtrapivotgrid-by-clicking-on-a-field-value-e1434/CS/Form1.cs#L28

private void HandleValueMouseClick(PivotFieldValueEventArgs e) {
    PivotGridField[] higherFields = e.GetHigherLevelFields();

how-to-mediate-a-pair-of-bridged-chart-and-pivot-grid-with-a-filter-control-e2597/CS/Form1.cs#L68

private void pivotGridControl1_FieldValueExpanded(object sender, DevExpress.XtraPivotGrid.PivotFieldValueEventArgs e) {
    TransferData(currentChartDataSourceType);

pivot-chart-integration-how-to-hide-specific-arguments-from-the-chart-e3205/CS/WindowsApplication53/Form1.cs#L38

private bool ShouldChartCurrentArgument(DevExpress.XtraPivotGrid.PivotFieldValueEventArgs valueInfo)
{

how-to-implement-sorting-for-a-custom-cell-value-e2149/CS/ImplementSortingforaCustomCellValue/Form1.cs#L169

}
void ApplySortByValue(PivotFieldValueEventArgs valueInfo) {
    if(valueInfo.DataField != valueInfo.Field) return;

sort-a-xtrapivotgrid-by-clicking-on-a-field-value-and-toggle-sort-order-e2705/CS/Form1.cs#L33

private void HandleValueMouseClick(PivotFieldValueEventArgs e) {
    PivotGridField[] higherFields = e.GetHigherLevelFields();

VB.NET

how-to-sort-a-xtrapivotgrid-by-clicking-on-a-field-value-e1434/VB/Form1.vb#L31

Private Sub HandleValueMouseClick(ByVal e As PivotFieldValueEventArgs)
    Dim higherFields() As PivotGridField = e.GetHigherLevelFields()

how-to-mediate-a-pair-of-bridged-chart-and-pivot-grid-with-a-filter-control-e2597/VB/Form1.vb#L69

Private Sub pivotGridControl1_FieldValueExpanded(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PivotFieldValueEventArgs) Handles pivotGridControl1.FieldValueExpanded
    TransferData(currentChartDataSourceType)

pivot-chart-integration-how-to-hide-specific-arguments-from-the-chart-e3205/VB/WindowsApplication53/Form1.vb#L35

Private Function ShouldChartCurrentArgument(ByVal valueInfo As DevExpress.XtraPivotGrid.PivotFieldValueEventArgs) As Boolean
    If Equals(valueInfo.DataField, fieldValueP) Then

how-to-implement-sorting-for-a-custom-cell-value-e2149/VB/ImplementSortingforaCustomCellValue/Form1.vb#L172

End Sub
Private Sub ApplySortByValue(ByVal valueInfo As PivotFieldValueEventArgs)
    If valueInfo.DataField IsNot valueInfo.Field Then

sort-a-xtrapivotgrid-by-clicking-on-a-field-value-and-toggle-sort-order-e2705/VB/Form1.vb#L35

Private Sub HandleValueMouseClick(ByVal e As PivotFieldValueEventArgs)
    Dim higherFields() As PivotGridField = e.GetHigherLevelFields()

Inheritance

Show 11 items

Object

EventArgs

PivotFieldEventArgsBase<PivotGridField>

PivotFieldValueEventArgsBase<PivotGridField>

PivotFieldValueEventArgs

PivotCustomColumnWidthEventArgs

PivotCustomRowHeightEventArgs

PivotFieldDisplayTextEventArgs

PivotFieldImageIndexEventArgs

PivotFieldValueCancelEventArgs

PivotFieldValueHitInfo