BarButtonItem(BarManager, String, Int32, BarShortcut) Constructor

Creates a new instance of the BarButtonItem class.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v18.2.dll

Declaration

C#

public BarButtonItem(
    BarManager manager,
    string caption,
    int imageIndex,
    BarShortcut shortcut
)

VB.NET

Public Sub New(
    manager As BarManager,
    caption As String,
    imageIndex As Integer,
    shortcut As BarShortcut
)

Parameters

Name	Type	Description
manager	BarManager	A BarManager object representing the Bar Manager owning the created item. This value is assigned to the BarItem.Manager property.
caption	String	A string value specifying the caption of the created item. This value is assigned to the BarItem.Caption property.
imageIndex	Int32	An integer value specifying the image of the created item by its index within the source collection. This value is assigned to the BarItem.ImageIndex property.
shortcut	BarShortcut	A BarShortcut object specifying the keyboard shortcut assigned to the created item. This value is assigned to the BarItem.ShortCut property.

Remarks

Use the constructor to create a new bar button item with the predefined caption, image and shortcut at runtime. The generated item is appended to the BarManager.Items collection of the Bar Manager specified by the manager parameter.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the BarButtonItem(BarManager, String, Int32, BarShortcut) constructor.

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.

VB.NET

how-to-create-a-table-bar-item-for-ribboncontrol-e4491/VB/testSample/TableBarItem/CustomBarItem/TableBarItem.vb#L37

Public Sub New(ByVal manager As BarManager, ByVal caption As String, ByVal imageIndex As Integer, ByVal shortcut As BarShortcut)
    MyBase.New(manager, caption, imageIndex, shortcut)