BaseListBoxControl.ContextButtonClick Event

Fires when a context button is clicked.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v20.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Behavior")]
public event ContextItemClickEventHandler ContextButtonClick

VB.NET

<DXCategory("Behavior")>
Public Event ContextButtonClick As ContextItemClickEventHandler

Event Data

The ContextButtonClick event's data class is ContextItemClickEventArgs. The following properties provide information specific to this event:

Property	Description
DataItem	Gets or sets an Object that contains a clicked ContextItem. This object is a control or a control’s item.
Item	Gets a clicked ContextItem.
ItemInfo	Gets or sets a clicked ContextItem‘s ContextItemViewInfo.
ScreenBounds	Returns a Rectangle that contains a ContextItem.

Remarks

The ContextButtonClick event fires when an end-user clicks any context button (see BaseListBoxControl.ContextButtons). The ContextItemClickEventArgs.Item property allows you to determine the button being clicked.

You can also handle the ContextItem.Click event to respond to a click on a particular button.

Example

C#

private void listBoxControl_ContextButtonClick(object sender, DevExpress.Utils.ContextItemClickEventArgs e) {
    if (e.Item.Name=="Delete") {
        var listBoxControl = (DevExpress.XtraEditors.ListBoxControl)sender;
        listBoxControl.Items.Remove(e.DataItem);                
    }            
}

VB.NET

Private Sub listBoxControl_ContextButtonClick(ByVal sender As Object, ByVal e As DevExpress.Utils.ContextItemClickEventArgs)
    If e.Item.Name="Delete" Then
       Dim listBoxControl = DirectCast(sender, DevExpress.XtraEditors.ListBoxControl)
       listBoxControl.Items.Remove(e.DataItem)
    End If
End Sub

Related GitHub Examples

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

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#

how-to-show-the-delete-button-when-an-end-user-hovers-the-mouse-over-the-listbox-item-e3397/CS/DeleteItemFromListBox/Form1.cs#L11

    listBoxControl1.ContextButtonClick += ListBoxControl1_ContextButtonClick;
}

VB.NET

how-to-show-the-delete-button-when-an-end-user-hovers-the-mouse-over-the-listbox-item-e3397/VB/DeleteItemFromListBox/Form1.vb#L14

    AddHandler listBoxControl1.ContextButtonClick, AddressOf ListBoxControl1_ContextButtonClick
End Sub