LayoutGroup.CustomHeaderButtons Property

Gets or sets the collection of custom buttons displayed in the group header.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v20.2.dll

Declaration

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

Property Value

Type Description
DevExpress.XtraEditors.ButtonPanel.BaseButtonCollection

A collection of buttons displayed in the group header.

Remarks

Use the CustomHeaderButtons property to add custom buttons to the group header:

LayoutControl-CustomHeaderButtons

At design time, you can add buttons to the CustomHeaderButtons collection using a dedicated editor.

LayoutControl-CustomHeaderButtons.png

The location of header buttons (the group's expand button and custom buttons) can be set with the LayoutGroup.HeaderButtonsLocation property.

To respond to clicking/checking custom buttons, handle the LayoutGroup.CustomButtonClick, LayoutGroup.CustomButtonChecked and LayoutGroup.CustomButtonUnchecked events.

Examples

The code below handles the LayoutGroup.CustomButtonClick event to hide the layout group with a click on a button in its header. To add buttons to the header, use the CustomHeaderButtons collection.

private void layoutControlGroup1_CustomButtonClick(object sender, DevExpress.XtraBars.Docking2010.BaseButtonEventArgs e) {
    LayoutControlGroup layoutGroup = sender as LayoutControlGroup;
    if (e.Button.Properties.Caption == "Hide")
        layoutGroup.HideToCustomization();
}
See Also