Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

XtraTabControl.CustomDrawHeaderButton Event

Allows you to custom paint header buttons (XtraTabControl.CustomHeaderButtons).

Namespace: DevExpress.XtraTab

Assembly: DevExpress.XtraEditors.v24.2.dll

NuGet Package: DevExpress.Win.Navigation

#Declaration

[DXCategory("Appearance")]
public event HeaderButtonCustomDrawEventHandler CustomDrawHeaderButton

#Event Data

The CustomDrawHeaderButton event's data class is HeaderButtonCustomDrawEventArgs. The following properties provide information specific to this event:

Property Description
Bounds Gets the rectangle that specifies the bounds of the header button.
Button Gets the button that is being drawn.
Info Provides access to the object that contains information about the button being drawn.
Painter Provides access to the object that performs paint operations. Inherited from ObjectCustomDrawEventArgs.

#Remarks

The CustomDrawHeaderButton event allows you to custom paint header buttons (XtraTabControl.CustomHeaderButtons). The Button event parameter idenfies the currently processed button.

To draw custom information, use the methods provided by the Cache or Graphics event parameter.

When you handle the CustomDrawHeaderButton event, you can invoke the button’s default rendering with the DefaultDraw method.

Set the Handled event parameter to true to indicate that you have handled the CustomDrawHeaderButton event and no default painting is required after your event handler is completed. If the event’s Handled parameter is set to false (the default value), the default painting mechanism will automatically be invoked after your custom draw event handler is completed. The default painting mechanism overrides all rendering you may have performed previously.

See Also