CustomHeaderButtonCollection.Add(CustomHeaderButton) Method

Adds a custom button to the current button collection.

Namespace: DevExpress.XtraTab.Buttons

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public virtual int Add(
    CustomHeaderButton button
)

VB.NET

Public Overridable Function Add(
    button As CustomHeaderButton
) As Integer

Parameters

Name	Type	Description
button	CustomHeaderButton	A CustomHeaderButton object that is the button that will be added.

Returns

Type	Description
Int32	An integer value that is a custom button’s index in the collection.

Example

The example demonstrates how to add two custom header buttons to the CustomHeaderButton collection.

C#

using DevExpress.XtraTab.Buttons;
using DevExpress.XtraEditors.Controls;

xtraTabControl1.CustomHeaderButtons.Add(new CustomHeaderButton(ButtonPredefines.Combo));
xtraTabControl1.CustomHeaderButtons.Add(new CustomHeaderButton(ButtonPredefines.Right));

VB.NET

Imports DevExpress.XtraTab.Buttons
Imports DevExpress.XtraEditors.Controls

xtraTabControl1.CustomHeaderButtons.Add(new CustomHeaderButton(ButtonPredefines.Combo))
xtraTabControl1.CustomHeaderButtons.Add(new CustomHeaderButton(ButtonPredefines.Right))

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Add(CustomHeaderButton) method.

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-tab-control-display-header-buttons/CS/XtraTabWithButtons/Form1.cs#L67

{
    xtraTabPageDescendant1.CustomButtons.Add(new CustomHeaderButton());
    xtraTabControlDescendant1.SelectedTabPage = xtraTabPageDescendant2;

VB.NET

winforms-tab-control-display-header-buttons/VB/XtraTabWithButtons/Form1.vb#L56

Private Sub simpleButton1_Click(ByVal sender As Object, ByVal e As EventArgs)
    xtraTabPageDescendant1.CustomButtons.Add(New CustomHeaderButton())
    xtraTabControlDescendant1.SelectedTabPage = xtraTabPageDescendant2