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.XtraTreeList

Assembly: DevExpress.XtraTreeList.v24.2.dll

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.

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-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.cs#L50

    e.Cache.DrawString(validationError, e.Appearance.Font, e.Cache.GetSolidBrush(Color.Black), e.Bounds);
    e.Handled = true;
}

winforms-treelist-show-checkboxes-for-specific-level/CS/WindowsApplication1/Form1.cs#L91

    e.ObjectArgs.State = DevExpress.Utils.Drawing.ObjectState.Disabled;
    e.Handled = NeedHide;
}

winforms-treelist-implement-group-level-style-feature/CS/Q220534/Form1.cs#L23

{
    e.Handled = true;
    TreeList tree = (TreeList)sender;

VB.NET

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.vb#L56

    e.Cache.DrawString(validationError, e.Appearance.Font, e.Cache.GetSolidBrush(Color.Black), e.Bounds)
    e.Handled = True
End Sub

winforms-treelist-show-checkboxes-for-specific-level/VB/WindowsApplication1/Form1.vb#L95

    e.ObjectArgs.State = DevExpress.Utils.Drawing.ObjectState.Disabled
    e.Handled = NeedHide
End Sub

winforms-treelist-implement-group-level-style-feature/VB/Q220534/Form1.vb#L21

Private Sub OnTreeListCustomDrawNodeIndent(ByVal sender As Object, ByVal e As CustomDrawNodeIndentEventArgs) Handles treeList.CustomDrawNodeIndent
    e.Handled = True
    Dim tree As TreeList = DirectCast(sender, TreeList)