RepositoryItemTextEdit.BeforeShowMenu Event

Occurs before the editor’s context menu is displayed.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Events")]
public event BeforeShowMenuEventHandler BeforeShowMenu

VB.NET

<DXCategory("Events")>
Public Event BeforeShowMenu As BeforeShowMenuEventHandler

Event Data

The BeforeShowMenu event's data class is DevExpress.XtraEditors.Controls.BeforeShowMenuEventArgs.

Remarks

Handle the BeforeShowMenu event to customize the editor’s context menu. The event fires each time the menu is about to be displayed.

The editor’s context menu, specified by the e.Menu event parameter, is represented by the DXPopupMenu class. Menu items are represented by DXMenuItem, DXMenuCheckItem and DXSubMenuItem objects.

Note

The BeforeShowMenu event is not raised in the following instances:

• The editor is disabled (the Enabled property is set to true).
• The editor’s Properties.TextEditStyle property is set to TextEditStyles.DisableTextEditor.

Example

The following code shows how to prevent an editor’s standard context menu from being displayed via the RepositoryItemTextEdit.BeforeShowMenu event.

C#

private void textEdit1_Properties_BeforeShowMenu(object sender, 
DevExpress.XtraEditors.Controls.BeforeShowMenuEventArgs e) {
    e.Menu.Items.Clear();
}

VB.NET

Private Sub TextEdit1_Properties_BeforeShowMenu(ByVal sender As System.Object, _
ByVal e As DevExpress.XtraEditors.Controls.BeforeShowMenuEventArgs) _
Handles TextEdit1.Properties.BeforeShowMenu
    e.Menu.Items.Clear()
End Sub