CustomDrawEventArgs.Handled Property

Gets or sets a value specifying whether an event was handled and that the default element painting is therefore not required.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

public bool Handled { get; set; }

VB.NET

Public Property Handled As Boolean

Property Value

Type	Description
Boolean	true if the default element painting is not required; otherwise, false.

Remarks

If custom drawing is implemented and the Handled property value remains set to false, all the custom drawing performed will be overwritten by the default painting mechanism using the appearance settings. These appearance settings are specified by the CustomDrawEventArgs.Appearance property.

Set the Handled property to true to prevent the default painting mechanism from clearing any custom drawing after a custom draw event handler has been completed.

The CustomDrawEventArgs.DefaultDraw method, when called, automatically sets the Handled property to true.

The CustomDrawEventArgs.DefaultDraw method does nothing if the Handled property has already been set to true.

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-grid-print-export-custom-painted-content/CS/MyXtraGrid/MyGridView/MyGridView.cs#L41

FooterCellCustomDrawEventArgs args = new FooterCellCustomDrawEventArgs(cache, -1, col, null, styleArgs);
args.Handled = true;
RaiseCustomDrawFooterCell(args);

winforms-grid-print-custom-draw-content/CS/MyXtraGrid/MyGridView/MyGridView.cs#L29

FooterCellCustomDrawEventArgs args = new FooterCellCustomDrawEventArgs(cache, -1, col, null, styleArgs);
args.Handled = true;
RaiseCustomDrawFooterCell(args);

winforms-grid-multiple-row-selection-web-style-checkboxes/CS/E1271/CheckMarkSelection.cs#L234

    DrawCheckBox(e.Cache, e.Bounds, SelectedCount == _view.DataRowCount);
    e.Handled = true;
}

winforms-grid-custom-button-in-column-header/CS/WindowsApplication3/ColumnHeaderExtender.cs#L115

    DrawCustomButton(e);
    e.Handled = true;
}

winforms-grid-enable-editing-in-group-row-to-change-cell-values/CS/WindowsApplication3/GroupEditProvider.cs#L198

    DrawGroupEditor(e);
    e.Handled = true;
}

VB.NET

winforms-grid-print-export-custom-painted-content/VB/MyXtraGrid/Form1.vb#L44

Private Sub myGridView1_CustomDrawFooterCell(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs) Handles myGridView1.CustomDrawFooterCell
    Dim isPrinting As Boolean = e.Handled
    e.Handled = True

winforms-grid-print-custom-draw-content/VB/MyXtraGrid/Form1.vb#L33

Private Sub myGridView1_CustomDrawFooterCell(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs) Handles myGridView1.CustomDrawFooterCell
    Dim isPrinting As Boolean = e.Handled
    e.Handled = True

winforms-grid-multiple-row-selection-web-style-checkboxes/VB/E1271/CheckMarkSelection.vb#L274

    DrawCheckBox(e.Cache, e.Bounds, SelectedCount = _view.DataRowCount)
    e.Handled = True
End If

winforms-grid-custom-button-in-column-header/VB/WindowsApplication3/ColumnHeaderExtender.vb#L123

    DrawCustomButton(e)
    e.Handled = True
End Sub

winforms-grid-enable-editing-in-group-row-to-change-cell-values/VB/WindowsApplication3/GroupEditProvider.vb#L188

    DrawGroupEditor(e)
    e.Handled = True
End If