PivotFieldImageIndexEventArgs Class

Provides data for the PivotGridControl.FieldValueImageIndex event.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.2.dll

Declaration

C#

public class PivotFieldImageIndexEventArgs :
    PivotFieldValueEventArgs

VB.NET

Public Class PivotFieldImageIndexEventArgs
    Inherits PivotFieldValueEventArgs

Related API Members

PivotFieldImageIndexEventArgs is the data class for the following events:

• PivotGridControl.FieldValueImageIndex

Remarks

The PivotGridControl.FieldValueImageIndex event allows you to display images within individual column and row areas.

An image can be assigned via the event’s PivotFieldImageIndexEventArgs.ImageIndex parameter. This represents the index of the required image within the PivotGridControl.ValueImages collection.

PivotFieldImageIndexEventArgs objects are automatically created, initialized and passed to PivotGridControl.FieldValueImageIndex event handlers.

Note

You cannot use the PivotFieldImageIndexEventArgs class members to access event data while an asynchronous operation is being performed. Use the pivot grid’s IThreadSafeAccessible.IsAsyncInProgress property to determine whether an operation is in progress. If this property returns true, use a thread-safe event parameter returned by the PivotFieldImageIndexEventArgs.ThreadSafeArgs property to access event data. To learn more, see Asynchronous Mode.

Inheritance

Object

EventArgs

PivotFieldEventArgsBase<PivotGridField>

PivotFieldValueEventArgsBase<PivotGridField>

PivotFieldValueEventArgs

PivotFieldImageIndexEventArgs