Back to Devexpress

BarItemLinkCollection.Add(BarItem, Boolean, String, String, Boolean) Method

windowsforms-devexpress-dot-xtrabars-dot-baritemlinkcollection-dot-add-x28-devexpress-dot-xtrabars-dot-baritem-system-dot-boolean-system-dot-string-system-dot-string-system-dot-boolean-x29.md

latest3.6 KB
Original Source

BarItemLinkCollection.Add(BarItem, Boolean, String, String, Boolean) Method

Creates a link to the specified bar item with the specified Key Tips, and adds it to the end of the collection. The method enables you to specifiy whether the created link starts a group, and whether it must be arranged in the same manner as a BarButtonGroup.

Namespace : DevExpress.XtraBars

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
public virtual BarItemLink Add(
    BarItem item,
    bool beginGroup,
    string keyTip,
    string dropDownKeyTip,
    bool buttonGroup
)
vb
Public Overridable Function Add(
    item As BarItem,
    beginGroup As Boolean,
    keyTip As String,
    dropDownKeyTip As String,
    buttonGroup As Boolean
) As BarItemLink

Parameters

NameTypeDescription
itemBarItem

A BarItem descendant for which a link is added to the collection. This value is assigned to the BarItemLink.Item property.

| | beginGroup | Boolean |

true to begin a group; otherwise, false. This value is used to initialize the created link’s BarItemLink.BeginGroup property.

| | keyTip | String |

A string that specifies the Key Tip for the link. This value is used to initialize the created link’s BarItemLink.KeyTip property.

| | dropDownKeyTip | String |

A string that specifies the Key Tip used to open the bar button item’s dropdown, if any. This value is used to initialize the created link’s BarButtonItemLink.DropDownKeyTip property.

| | buttonGroup | Boolean |

A Boolean value that specifies whether the bar item link is arranged in the same manner as a BarButtonGroup object . This value is used to initialize the created link’s BarItemLink.ActAsButtonGroup property. This parameter is in effect in a RibbonControl.

|

Returns

TypeDescription
BarItemLink

A BarItemLink object representing the added link.

|

See Also

RibbonControl

BarItemLinkCollection Class

BarItemLinkCollection Members

DevExpress.XtraBars Namespace