Skip to main content

GroupControl.CustomHeaderButtons Property

Specifies a collection of custom header buttons.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.Utils.v23.2.dll

NuGet Packages: DevExpress.Utils, DevExpress.Wpf.Core

Declaration

[ListBindable(false)]
[DXCategory("Custom Header Buttons")]
public virtual BaseButtonCollection CustomHeaderButtons { get; }

Property Value

Type Description
DevExpress.XtraEditors.ButtonPanel.BaseButtonCollection

A CollectionBase descendant that stores custom header buttons for this GroupControl.

Remarks

The GroupControl displays custom buttons in the header.

Note

The control’s header and custom header buttons are hidden if the GroupControl.ShowCaption property is set to false or the PanelControl.BorderStyle property is set to NoBorder.

To add custom buttons in the designer, click Add Custom Header Buttons in the control’s smart-tag menu.

GroupControl - Add Custom Header Buttons

Use the collection editor to add, re-arrange, or remove custom buttons.

GroupControl - Custom Header Buttons Editor

Use a button’s Style property to specify whether it is a push or check button. Use the Checked property to get or set whether a check button is checked. When a user clicks a header button, the control raises the GroupControl.CustomButtonClick, and GroupControl.CustomButtonChecked or GroupControl.CustomButtonUnchecked event.

The control displays custom buttons before the group’s caption. Set the GroupControl.CustomHeaderButtonsLocation property to AfterText to display custom buttons after the group’s caption. Note that this setting affects all custom buttons in the control.

image image

See Also