EditorButtonCollection.Add(EditorButton) Method

Adds the specified button to the button collection.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public virtual int Add(
    EditorButton button
)

VB.NET

Public Overridable Function Add(
    button As EditorButton
) As Integer

Parameters

Name	Type	Description
button	EditorButton	The EditorButton object specifying the button to insert into the collection.

Returns

Type	Description
Int32	The zero-based index of the button within the collection.

Remarks

The Add method allows you to add a new button to the end of the current button collection. If the button already exists in the collection, the method does nothing.

The value returned by the Add method specifies the position of the new element or the position of the existing element in the collection.

To add a number of buttons to the collection at once, see the EditorButtonCollection.AddRange method.

The total number of buttons in the collection is specified by the Count property. The number of visible buttons is returned by the EditorButtonCollection.VisibleCount property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Add(EditorButton) 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-custom-buttonedit-display-editvalue-on-button/CS/TestMyButtonEdit/RepositoryItemMyButtonEdit.cs#L54

    eb.IsDefaultButton = true;
    Buttons.Add(eb);
}

winforms-grid-customize-find-panel/CS/MyXtraGrid/MyFindControl.cs#L42

ButtonEdit be = FindControl("teFind") as ButtonEdit;
be.Properties.Buttons.Add(new EditorButton(ButtonPredefines.Ellipsis));
be.ButtonClick += be_ButtonClick;

XAF-how-to-add-an-unbound-column-to-gridlisteditor-to-execute-a-custom-action-for-a-record/CS/WinSolution.Module.Win/SimpleBusinessActionGridListViewController.cs#L86

properties.Buttons.Clear();
properties.Buttons.Add(button);
properties.EndInit();

VB.NET

winforms-custom-buttonedit-display-editvalue-on-button/VB/TestMyButtonEdit/RepositoryItemMyButtonEdit.vb#L40

    eb.IsDefaultButton = True
    Buttons.Add(eb)
End Sub

winforms-grid-customize-find-panel/VB/MyXtraGrid/MyFindControl.vb#L39

Dim be As ButtonEdit = TryCast(FindControl("teFind"), ButtonEdit)
be.Properties.Buttons.Add(New EditorButton(ButtonPredefines.Ellipsis))
AddHandler be.ButtonClick, AddressOf be_ButtonClick

XAF-how-to-add-an-unbound-column-to-gridlisteditor-to-execute-a-custom-action-for-a-record/VB/WinSolution.Module.Win/SimpleBusinessActionGridListViewController.vb#L103

properties.Buttons.Clear()
properties.Buttons.Add(button)
properties.EndInit()