RepositoryItemTokenEdit.RemoveTokenButtonClick Event

Occurs when a user clicks the Remove button in the TokenEdit drop-down menu.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

[DXCategory("Events")]
public event EventHandler<RemoveTokenButtonClickEventArgs> RemoveTokenButtonClick

VB.NET

<DXCategory("Events")>
Public Event RemoveTokenButtonClick As EventHandler(Of RemoveTokenButtonClickEventArgs)

Event Data

The RemoveTokenButtonClick event's data class is DevExpress.XtraEditors.RemoveTokenButtonClickEventArgs.

Remarks

If the RepositoryItemTokenEdit.ShowRemoveTokenButtons property is set to true, tokens in the drop-down menu display the Remove button.

In unbound mode, set the e.Cancel property to true to keep the token and ignore the user’s click action.

C#

void TokenEdit1_RemoveTokenButtonClick(object sender, RemoveTokenButtonClickEventArgs e) {
    if (e.Text == "admin")
        e.Cancel = true;
}

VB.NET

Private Sub TokenEdit1_RemoveTokenButtonClick(ByVal sender As Object, ByVal e As RemoveTokenButtonClickEventArgs)
    If e.Text = "admin" Then
        e.Cancel = True
    End If
End Sub

In unbound mode, the e.Cancel property has no effect because tokens are stored in a data source rather than in the RepositoryItemTokenEdit.Tokens collection. To remove tokens from the drop-down menu, you need to remove them from the data source.

C#

void TokenEdit1_RemoveTokenButtonClick(object sender, RemoveTokenButtonClickEventArgs e) {
    if (e.Text != "admin")
        //use data source API to remove a token
        //read the e.RowObject property to obtain a data source record
}

VB.NET

Private Sub TokenEdit1_RemoveTokenButtonClick(ByVal sender As Object, ByVal e As RemoveTokenButtonClickEventArgs)
    If e.Text <> "admin" Then
        'use data source API to remove a token
        'read the e.RowObject property to obtain a data source record
    End If
End Sub