DockPanel.CustomHeaderButtons Property

Gets all custom header buttons used within the current DockPanel.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[ListBindable(false)]
public ButtonCollection CustomHeaderButtons { get; }

VB.NET

<ListBindable(False)>
Public ReadOnly Property CustomHeaderButtons As ButtonCollection

Property Value

Type	Description
DevExpress.XtraBars.Docking2010.ButtonCollection	A DevExpress.XtraBars.Docking2010.ButtonCollection object that stores all custom header buttons used within the current DockPanel.

Remarks

The CustomHeaderButtons collection provides zero-based indexed access to all custom header buttons used within the current DockPanel. Once you get this collection, you can add new custom buttons or modify/remove existing ones. See the Header Buttons topic to learn more.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomHeaderButtons 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-docking-display-custom-header-buttons/CS/CustomHeaderButtonsExample/Form1.cs#L33

void panelContainer1_CustomButtonChecked(object sender, DevExpress.XtraBars.Docking2010.ButtonEventArgs e) {
    if (e.Button == panelContainer1.CustomHeaderButtons[4]) (panelContainer1.ActiveChild.ControlContainer.Controls[0] as MemoEdit).Properties.Appearance.TextOptions.HAlignment = HorzAlignment.Near;
    if (e.Button == panelContainer1.CustomHeaderButtons[3]) (panelContainer1.ActiveChild.ControlContainer.Controls[0] as MemoEdit).Properties.Appearance.TextOptions.HAlignment = HorzAlignment.Center;

VB.NET

winforms-docking-display-custom-header-buttons/VB/Form1.vb#L35

Private Sub panelContainer1_CustomButtonChecked(ByVal sender As Object, ByVal e As DevExpress.XtraBars.Docking2010.ButtonEventArgs)
    If (e.Button Is panelContainer1.CustomHeaderButtons(4)) Then
        TryCast(panelContainer1.ActiveChild.ControlContainer.Controls(0), MemoEdit).Properties.Appearance.TextOptions.HAlignment = HorzAlignment.Near