PivotCustomDrawFieldValueEventArgs.Area Property

Gets the header area where the field is displayed.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v23.2.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public PivotArea Area { get; }

VB.NET

Public ReadOnly Property Area As PivotArea

Property Value

Type	Description
PivotArea	A PivotArea enumeration value that specifies the header area in which the field is displayed.

Available values:

Name	Description
RowArea	Corresponds to the Row Header Area.
ColumnArea	Corresponds to the Column Header Area.
FilterArea	Corresponds to the Filter Header Area.
DataArea	Corresponds to the Data Header Area.

Remarks

For more information, see Header Area.

Note

If you try to access the Area property while an asynchronous operation is being performed, an exception will be thrown. When the operation is in progress, use the PivotCustomDrawFieldValueThreadSafeEventArgs.Area property exposed by a thread-safe event parameter instead. To access the thread-safe event parameter, use the PivotCustomDrawFieldValueEventArgs.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 snippets (auto-collected from DevExpress Examples) contain references to the Area 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-pivot-change-the-field-value-header-appearance-backcolor/CS/WindowsApplication53/Form1.cs#L21

private void pivotGridControl1_CustomDrawFieldValue(object sender, PivotCustomDrawFieldValueEventArgs e) {
    if (e.Area == PivotArea.ColumnArea) {
        e.Appearance.BackColor = Color.GreenYellow;

winforms-pivot-grid-hide-the-grand-total-column-and-text-labels/CS/RemoveGridLinesExample/Form1.cs#L23

void pivotGridControl1_CustomDrawFieldValue(object sender, PivotCustomDrawFieldValueEventArgs e) {
    if (e.Area == PivotArea.ColumnArea) {
        e.Graphics.FillRectangle(Brushes.White, e.Bounds);

VB.NET

winforms-pivot-change-the-field-value-header-appearance-backcolor/VB/WindowsApplication53/Form1.vb#L23

Private Sub pivotGridControl1_CustomDrawFieldValue(ByVal sender As Object, ByVal e As PivotCustomDrawFieldValueEventArgs) Handles pivotGridControl1.CustomDrawFieldValue
    If e.Area = PivotArea.ColumnArea Then
        e.Appearance.BackColor = Color.GreenYellow

winforms-pivot-grid-hide-the-grand-total-column-and-text-labels/VB/RemoveGridLinesExample/Form1.vb#L27

Private Sub pivotGridControl1_CustomDrawFieldValue(ByVal sender As Object, ByVal e As PivotCustomDrawFieldValueEventArgs)
    If e.Area = PivotArea.ColumnArea Then
        e.Graphics.FillRectangle(Brushes.White, e.Bounds)