BaseListBoxControl.ContextButtonClick Event

Fires when a context button is clicked.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.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