PivotFieldImageIndexEventArgs.ValueType Property

Gets the type of the currently processed column/row header.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.2.dll

Declaration

C#

public PivotGridValueType ValueType { get; }

VB.NET

Public ReadOnly Property ValueType As PivotGridValueType

Property Value

Type	Description
PivotGridValueType	A PivotGridValueType enumeration value which identifies the type of the currently processed column or row header.

Available values:

Name	Description
Value	Corresponds to a field value.
Total	Corresponds to an automatic total.
GrandTotal	Corresponds to a grand total.
CustomTotal	Corresponds to a custom total.

Remarks

The ValueType property determines whether the currently processed header is a field value, grand total header, automatic total header or custom total header.

Note

If you try to access the ValueType property while an asynchronous operation is being performed, an exception will be thrown. When the operation is in progress, use the PivotFieldImageIndexThreadSafeEventArgs.ValueType property exposed by a thread-safe event parameter instead. To access the thread-safe event parameter, use the PivotFieldImageIndexEventArgs.ThreadSafeArgs property. To determine whether an asynchronous operation is being performed, 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 ValueType 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#L37

private void pivotGridControl1_FieldValueImageIndex(object sender, PivotFieldImageIndexEventArgs e) {
    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