NavigatorButtonBase.Tag Property

Gets or sets the data associated with the button.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
Object	null	An object that contains information which is associated with the button.

Remarks

The Tag property can be used to store any object that you want to associate with a button. Any type derived from the Object class can be assigned to this property via code. At design time, a specially designed dialog is used to set this property’s value. This dialog enables you to choose the data type and enter the desired value.

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-grid-data-navigator-custom-button/CS/CustomButton/Form1.cs#L25

button = gridControl1.EmbeddedNavigator.Buttons.CustomButtons.Add();
button.Tag = "copy";
button.Hint = "Copy to clipboard";

winforms-grid-auto-expand-new-master-row/CS/Q205071/Form1.cs#L28

private void OnGridControlEmbeddedNavigatorButtonClick(object sender, NavigatorButtonClickEventArgs e) {
    if (e.Button.Tag != null && e.Button.Tag.ToString() == "update") {
        if (gridControl1.FocusedView == gridView1) nwindDataSet.Categories.AcceptChanges();

winforms-grid-sql-pagination/CS/DxSample/MainForm.cs#L50

int offset = (int)DataAdapter.SelectCommand.Parameters["@offset"].Value;
string tag = (string)e.Button.Tag;
switch(tag) {

VB.NET

winforms-grid-data-navigator-custom-button/VB/CustomButton/Form1.vb#L24

button = gridControl1.EmbeddedNavigator.Buttons.CustomButtons.Add()
button.Tag = "copy"
button.Hint = "Copy to clipboard"

winforms-grid-auto-expand-new-master-row/VB/Q205071/Form1.vb#L26

Private Sub OnGridControlEmbeddedNavigatorButtonClick(ByVal sender As Object, ByVal e As NavigatorButtonClickEventArgs)
    If e.Button.Tag IsNot Nothing AndAlso Equals(e.Button.Tag.ToString(), "update") Then
        If gridControl1.FocusedView Is gridView1 Then

winforms-grid-sql-pagination/VB/DxSample/MainForm.vb#L58

Dim offset As Integer = DirectCast(DataAdapter.SelectCommand.Parameters("@offset").Value, Integer)
Dim tag As String = CStr(e.Button.Tag)
Select Case tag