BarItem.Tag Property

Gets or sets an object that contains data on the current item.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

[DefaultValue(null)]
public object Tag { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property Tag As Object

Property Value

Type	Default	Description
Object	*null*	An Object that contains data on the current item.

Remarks

Any user value can be assigned to this property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Tag 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.

C#

winforms-the-richeditcontrols-common-api-t210437/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L18

buttonCustomAction.ItemClick += buttonCustomAction_ItemClick_ShowSearchFormMethod;
buttonCustomAction.Tag = richEditControl;
richEditControl.Text = "Click the 'Custom Action' button located in the ribbon to invoke the 'Find and Replace' dialog switched to the 'Find' tab and with the 'test' word used for search";

Reporting_how-to-sort-report-data-in-print-preview-by-using-a-drop-down-menu-t210208/CS/dxSampleGroupSort/SortReportTableHelpers/HelpSortItem.cs#L101

SortOrder sortOrder = ColumnSortOrder;
BarCheckItemLink menuItem = Menu.ItemLinks.OfType<BarCheckItemLink>().FirstOrDefault(x => (x.Item.Tag != null && x.Item.Tag is SortOrder && (SortOrder)x.Item.Tag == sortOrder));
(menuItem.Item as BarCheckItem).Checked = true;

Reporting_embedded-end-user-report-designer-demonstration-e20017/CS/Contacts/Main.cs#L317

edit.ItemClick += new ItemClickEventHandler(edit_ItemClick);
edit.Tag = f;
b.AddItem(edit);

mruitem-with-pinning-e323/CS/WindowsApplication123/Form1.cs#L62

{
    if (Equals(list[i].Tag, obj))
    {

how-to-display-spellchecker-context-menu-for-standard-text-controls-textbox-and-richtextbox-t236002/CS/SpellCheckerMenuExample/Form1.cs#L49

item.Enabled = command.Enabled;
item.Tag = command;
item.ItemClick += new ItemClickEventHandler(OnPopupMenuItemClick);

VB.NET

winforms-the-richeditcontrols-common-api-t210437/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L20

AddHandler buttonCustomAction.ItemClick, AddressOf buttonCustomAction_ItemClick_ShowSearchFormMethod
buttonCustomAction.Tag = richEditControl
richEditControl.Text = "Click the 'Custom Action' button located on the RibbonControl to invoke the 'Find and Replace' dialog switched to the 'Search' tab and with the 'test' word used for search"

Reporting_how-to-sort-report-data-in-print-preview-by-using-a-drop-down-menu-t210208/VB/dxSampleGroupSort/SortReportTableHelpers/ReportColumnSortHelper.vb#L47

itemNone.Width = 100
itemNone.Tag = sortMode
itemNone.Caption = itemNone.Tag.ToString()

Reporting_embedded-end-user-report-designer-demonstration-e20017/VB/Contacts/Main.vb#L275

AddHandler edit.ItemClick, AddressOf edit_ItemClick
edit.Tag = f
b.AddItem(edit)

mruitem-with-pinning-e323/VB/WindowsApplication123/Form1.vb#L59

For i As Integer = 0 To list.Count - 1
    If Equals(list(i).Tag, obj) Then
        item = list(i)

how-to-display-spellchecker-context-menu-for-standard-text-controls-textbox-and-richtextbox-t236002/VB/SpellCheckerMenuExample/Form1.vb#L44

item.Enabled = command.Enabled
item.Tag = command
AddHandler item.ItemClick, AddressOf OnPopupMenuItemClick