Back to Devexpress

BarItem.Id Property

windowsforms-devexpress-dot-xtrabars-dot-baritem-a7e35dc1.md

latest3.4 KB
Original Source

BarItem.Id Property

Uniquely identifies the current BarItem.

Namespace : DevExpress.XtraBars

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[Browsable(false)]
[DefaultValue(-1)]
[XtraSerializableProperty]
public int Id { get; set; }
vb
<Browsable(False)>
<XtraSerializableProperty>
<DefaultValue(-1)>
Public Property Id As Integer

Property Value

TypeDefaultDescription
Int32-1

The current BarItem‘s unique identifier.

|

Remarks

To allow the bars’ layout to be saved and restored correctly each bar item’s Id property must be set to a unique integer.

When creating bar items at design time the Id property is initialized automatically.

If you create bar items via code and wish the bars’ layout to be stored and restored correctly, you need to set the Id property manually. To initialize the Id property the BarManager.GetNewItemId method can be used.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Id property.

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.

winforms-assign-popupmenu-to-dropdownbutton/CS/DropDownButtonExample/Form1.cs#L29

csharp
item.Caption = caption;
item.Id = this.barManager1.GetNewItemId();
item.ImageOptions.ImageIndex = imageIndex;

winforms-assign-popupmenu-to-dropdownbutton/VB/DropDownButtonExample/Form1.vb#L30

vb
item.Caption = caption
item.Id = barManager1.GetNewItemId()
item.ImageOptions.ImageIndex = imageIndex

See Also

GetNewItemId()

Saving and Restoring a Bars Layout Automatically

Saving and Restoring a Bars Layout Manually

BarItem Class

BarItem Members

DevExpress.XtraBars Namespace