PivotCustomDrawEventArgs.Handled Property

Gets or sets whether an event was handled, if it was handled the default actions are not required.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v23.2.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public bool Handled { get; set; }

VB.NET

Public Property Handled As Boolean

Property Value

Type	Description
Boolean	true if default painting isn’t required; otherwise, false.

Remarks

The events used to custom paint the various elements of a Pivot Grid Control fire before the elements are painted in their default manner. If the event parameter’s Handled property is set to true within a handler, default painting will not be performed. Otherwise, any custom painting performed within an event handler will be overridden by the Pivot Grid Control’s standard drawing.

Note

If you try to access the Handled property while an asynchronous operation is being performed, an exception will be thrown. When the operation is in progress, use the PivotCustomDrawThreadSafeEventArgs.Handled property exposed by a thread-safe event parameter instead. To access the thread-safe event parameter, use the PivotCustomDrawEventArgs.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 Handled 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-grid-draw-a-custom-element-on-mouse-hover/CS/WindowsApplication73/Form1.cs#L54

    e.Graphics.FillRectangle(Brushes.Chartreuse, rect);
    e.Handled = true;
}

sort-a-xtrapivotgrid-by-clicking-on-a-field-value-and-toggle-sort-order-e2705/CS/Form1.cs#L107

    data.ActiveLookAndFeel.Painter.SortedShape.DrawObject(sortInfo);
    e.Handled = true;
}

winforms-pivot-change-the-field-value-header-appearance-backcolor/CS/WindowsApplication53/Form1.cs#L28

    e.GraphicsCache.FillRectangle(e.GraphicsCache.GetSolidBrush(Color.FromArgb(50, 0, 0, 200)), e.Bounds);
    e.Handled = true;
}

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

    e.Graphics.FillRectangle(Brushes.White, e.Bounds);
    e.Handled = true;
}

VB.NET

winforms-pivot-grid-draw-a-custom-element-on-mouse-hover/VB/WindowsApplication73/Form1.vb#L53

    e.Graphics.FillRectangle(Brushes.Chartreuse, rect)
    e.Handled = True
End If

sort-a-xtrapivotgrid-by-clicking-on-a-field-value-and-toggle-sort-order-e2705/VB/Form1.vb#L120

    data.ActiveLookAndFeel.Painter.SortedShape.DrawObject(sortInfo)
    e.Handled = True
End Sub

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

    e.GraphicsCache.FillRectangle(e.GraphicsCache.GetSolidBrush(Color.FromArgb(50, 0, 0, 200)), e.Bounds)
    e.Handled = True
End If

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

    e.Graphics.FillRectangle(Brushes.White, e.Bounds)
    e.Handled = True
End If