BarLargeButtonItem(BarManager, String, Int32, BarShortcut) Constructor

Creates an instance of the BarLargeButtonItem class with predefined settings.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v24.2.dll

Declaration

C#

public BarLargeButtonItem(
    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 that specifies the Bar Manager owning the created item. This value is assigned to the BarItem.Manager property.
caption	String	A string value representing the caption of the created item. This value is assigned to the BarItem.Caption property.
imageIndex	Int32	An integer value specifying the index of the image displayed within links associated with the created item. This value is assigned to the BarItem.ImageIndex property.
shortcut	BarShortcut	A BarShortcut object that specifies the key combination used to access links associated with the created item. This value is assigned to the BarItem.ItemShortcut property.

Remarks

Use this constructor to create a large button item with a predefined caption, image and shortcut at runtime.

When a new large button item is created, it is automatically appended to the BarManager.Items collection of the Bar Manager specified by the manager parameter. Thus, you can use either the Bar.AddItem or Bar.InsertItem method to add this item to a bar that belongs to the same BarManager.