Back to Devexpress

PivotFieldImageIndexEventArgs.CustomTotal Property

windowsforms-devexpress-dot-xtrapivotgrid-dot-pivotfieldimageindexeventargs.md

latest3.3 KB
Original Source

PivotFieldImageIndexEventArgs.CustomTotal Property

Gets the custom total that corresponds to the currently processed column/row header.

Namespace : DevExpress.XtraPivotGrid

Assembly : DevExpress.XtraPivotGrid.v25.2.dll

NuGet Package : DevExpress.Win.PivotGrid

Declaration

csharp
public PivotGridCustomTotal CustomTotal { get; }
vb
Public ReadOnly Property CustomTotal As PivotGridCustomTotal

Property Value

TypeDescription
PivotGridCustomTotal

A PivotGridCustomTotal object that specifies the custom total that corresponds to the currently processed column/row header.

|

Remarks

If the currently processed header corresponds to a custom total the PivotFieldImageIndexEventArgs.ValueType property returns the PivotGridValueType.CustomTotal value and the CustomTotal property returns a PivotGridCustomTotal object that represents this custom total.

If the currently processed header does not correspond to a custom total, the CustomTotal property returns null.

Note

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

See Also

ValueType

PivotFieldImageIndexEventArgs Class

PivotFieldImageIndexEventArgs Members

DevExpress.XtraPivotGrid Namespace