EditorButton.Tag Property

Gets or sets a value that identifies the current button.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DefaultValue(null)]
[DXCategory("Data")]
public virtual object Tag { get; set; }

VB.NET

<DefaultValue(Nothing)>
<DXCategory("Data")>
Public Overridable Property Tag As Object

Property Value

Type	Default	Description
Object	*null*	A Object that identifies the current EditorButton instance.

Remarks

The Tag property can be used to associate a custom object with the editor button and this can be used to identify the button from among the other buttons.

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#

gridview-how-to-add-a-custom-button-to-the-filterpanel-t375271/CS/CustomGrid.cs#L111

ObjectState state = ObjectState.Normal;
if (button.Tag is ObjectState)
    state = (ObjectState)button.Tag;

custom-editor-how-to-create-a-fileedit-e4097/CS/CustomEditor/Form1.cs#L47

item.Buttons[1].Image = CustomEditor.Properties.Resources.open;
item.Buttons[1].Tag = "OpenFileDialog";
return item;

custom-editor-how-to-create-an-editor-with-an-image-on-one-of-its-sides-e3141/CS/WindowsApplication1/CustomEditor/MyButtonEditPainter.cs#L17

{
    if ("IsImage".Equals(info.Button.Tag))
    {

how-to-color-specific-buttonedits-buttons-by-taking-into-account-the-current-skin-t522495/CS/dxCustomButtonEdit/CustomButtonEdit.cs#L87

{
    if (info.Button.Tag != null && info.Button.Tag.ToString() == "Custom")
    {

VB.NET

gridview-how-to-add-a-custom-button-to-the-filterpanel-t375271/VB/CustomGrid.vb#L113

Dim state As ObjectState = ObjectState.Normal
If TypeOf button.Tag Is ObjectState Then
    state = CType(button.Tag, ObjectState)

custom-editor-how-to-create-a-fileedit-e4097/VB/CustomEditor/Form1.vb#L49

item.Buttons(1).Image = My.Resources.open
item.Buttons(1).Tag = "OpenFileDialog"
Return item

custom-editor-how-to-create-an-editor-with-an-image-on-one-of-its-sides-e3141/VB/WindowsApplication1/CustomEditor/MyButtonEditPainter.vb#L15

Protected Overrides Sub DrawButton(ByVal viewInfo As DevExpress.XtraEditors.ViewInfo.ButtonEditViewInfo, ByVal info As EditorButtonObjectInfoArgs)
    If "IsImage".Equals(info.Button.Tag) Then
        Dim bounds As Rectangle = info.Bounds

how-to-color-specific-buttonedits-buttons-by-taking-into-account-the-current-skin-t522495/VB/dxCustomButtonEdit/CustomButtonEdit.vb#L86

Protected Overrides Sub DrawButton(ByVal viewInfo As ButtonEditViewInfo, ByVal info As EditorButtonObjectInfoArgs)
    If info.Button.Tag IsNot Nothing AndAlso info.Button.Tag.ToString() = "Custom" Then
        Dim look = New UserLookAndFeel(viewInfo.OwnerEdit)