CustomDrawObjectEventArgs.Handled Property

Gets or sets a value specifying whether the control must perform default painting after an event handler has been executed.

Namespace: DevExpress.XtraNavBar.ViewInfo

Assembly: DevExpress.XtraNavBar.v18.2.dll

Declaration

C#

public virtual bool Handled { get; set; }

VB.NET

Public Overridable Property Handled As Boolean

Property Value

Type	Description
Boolean	true if the control doesn’t perform default object painting after an event handler has been executed; otherwise false.

Remarks

Events, for which the CustomDrawObjectEventArgs class provides data, fire before a corresponding object is painted. If an event handler sets the Handled property to true, default object painting is not performed. Otherwise the control will paint the object using its default after the handler has been executed.

This property can be used, for instance, to apply custom drawing only to those objects, which satisfy some specific conditions.

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#

how-to-custom-paint-navbar-links-e4128/CS/NavBarSample/Form1.cs#L43

    e.Appearance.DrawString(e.Cache, e.Caption, linkInfo.RealCaptionRectangle, Brushes.White);
    e.Handled = true;
}

how-to-add-a-checkbox-to-the-navbar-groups-caption-e2061/CS/WindowsApplication1/NavBarGroupStateHelper.cs#L106

    DrawCheckBox(e.Graphics, checkBoxBounds, IsGroupEnabled(info.Group));
    e.Handled = true;
}

how-to-implement-the-quick-search-feature-for-the-navbarcontrol-e5220/CS/WindowsFormsApplication72/SearchHelper.cs#L57

    e.Graphics.DrawString(e.Caption, e.Appearance.Font, Brushes.Black, rect);
    e.Handled = true;
}

VB.NET

how-to-custom-paint-navbar-links-e4128/VB/NavBarSample/Form1.vb#L43

    e.Appearance.DrawString(e.Cache, e.Caption, linkInfo.RealCaptionRectangle, Brushes.White)
    e.Handled = True
End If

how-to-add-a-checkbox-to-the-navbar-groups-caption-e2061/VB/WindowsApplication1/NavBarGroupStateHelper.vb#L109

    DrawCheckBox(e.Graphics, checkBoxBounds, IsGroupEnabled(info.Group))
    e.Handled = True
Finally

how-to-implement-the-quick-search-feature-for-the-navbarcontrol-e5220/VB/WindowsFormsApplication72/SearchHelper.vb#L54

    e.Graphics.DrawString(e.Caption, e.Appearance.Font, Brushes.Black, rect)
    e.Handled = True
End If