PivotFieldImageIndexEventArgs.ImageIndex Property

Gets or sets the index of the image to display within the currently processed column/row header.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.1.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public int ImageIndex { get; set; }

VB.NET

Public Property ImageIndex As Integer

Property Value

Type	Description
Int32	An integer value specifying the zero-based index of the image within the source collection.

Remarks

The source of images is specified by the Pivot Grid Control’s PivotGridControl.ValueImages property.

Note

If you try to access the ImageIndex property while an asynchronous operation is being performed, an exception will be thrown. When the operation is in progress, use the PivotFieldImageIndexThreadSafeEventArgs.ImageIndex 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 ImageIndex 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