RepositoryItemTextEdit.BeforeShowMenu Event

Occurs before the editor’s context menu is displayed.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v20.2.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

You can handle this 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 event’s Menu parameter, is represented by the DXPopupMenu class. Menu items are represented by the DXMenuItem, DXMenuCheckItem and DXSubMenuItem objects.

Note

On Windows 7 x64, if an exception is raised within a BeforeShowMenu event handler, it is suppressed by the .NET Framework. This behavior is not reproducible in other Windows OS versions.

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