PivotFieldImageIndexEventArgs.Value Property

Gets the column field or row field value that corresponds to the currently processed column/row header.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.1.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public object Value { get; }

VB.NET

Public ReadOnly Property Value As Object

Property Value

Type	Description
Object	The field value currently being processed.

Remarks

If the currently processed header is a field value or total header the Value property returns the value of the corresponding column field or row field. If the currently processed header is a grand total header or data field header the Value property will return null.

To determine the type of the currently processed header, use the PivotFieldImageIndexEventArgs.ValueType property.

Note

If you try to access the Value property while an asynchronous operation is being performed, an exception will be thrown. To determine whether the operation is in progress, use the pivot grid’s IThreadSafeAccessible.IsAsyncInProgress property. For more information, see Asynchronous Mode.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Value property.

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#

winforms-implement-custom-drawing-for-the-chartcontrol-that-is-bound-to-the-pivotgrid-control/CS/WindowsFormsApplication8/Form1.cs#L38

    if (e.Field == fieldRegion && e.ValueType == PivotGridValueType.Value)
        e.ImageIndex = GetIndexByName(e.Value);
}

VB.NET

winforms-implement-custom-drawing-for-the-chartcontrol-that-is-bound-to-the-pivotgrid-control/VB/WindowsFormsApplication8/Form1.vb#L31

Private Sub pivotGridControl1_FieldValueImageIndex(ByVal sender As Object, ByVal e As PivotFieldImageIndexEventArgs)
    If e.Field Is fieldRegion AndAlso e.ValueType = PivotGridValueType.Value Then e.ImageIndex = GetIndexByName(e.Value)
End Sub