Back to Devexpress

DockPanel.CustomHeaderButtons Property

windowsforms-devexpress-dot-xtrabars-dot-docking-dot-dockpanel-d6f980b1.md

latest4.0 KB
Original Source

DockPanel.CustomHeaderButtons Property

Gets all custom header buttons used within the current DockPanel.

Namespace : DevExpress.XtraBars.Docking

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[ListBindable(false)]
public ButtonCollection CustomHeaderButtons { get; }
vb
<ListBindable(False)>
Public ReadOnly Property CustomHeaderButtons As ButtonCollection

Property Value

TypeDescription
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.

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.

winforms-docking-display-custom-header-buttons/CS/CustomHeaderButtonsExample/Form1.cs#L33

csharp
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;

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

vb
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

See Also

Header Buttons

DockPanel Class

DockPanel Members

DevExpress.XtraBars.Docking Namespace