Back to Devexpress

RichEditControl.PreparePopupMenu Event

windowsforms-devexpress-dot-xtrarichedit-dot-richeditcontrol-0d7c8981.md

latest2.7 KB
Original Source

RichEditControl.PreparePopupMenu Event

OBSOLETE

You should use the 'PopupMenuShowing' instead

Occurs before a context (popup) menu is created for the control’s document every time a context menu is being invoked.

Namespace : DevExpress.XtraRichEdit

Assembly : DevExpress.XtraRichEdit.v25.2.dll

NuGet Package : DevExpress.Win.RichEdit

Declaration

csharp
[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
[Obsolete("You should use the 'PopupMenuShowing' instead", false)]
public event PreparePopupMenuEventHandler PreparePopupMenu
vb
<Browsable(False)>
<EditorBrowsable(EditorBrowsableState.Never)>
<Obsolete("You should use the 'PopupMenuShowing' instead", False)>
Public Event PreparePopupMenu As PreparePopupMenuEventHandler

Event Data

The PreparePopupMenu event's data class is DevExpress.XtraRichEdit.PreparePopupMenuEventArgs.

Remarks

Handle the PreparePopupMenu event to modify items in the context menu. The current context menu can be accessed via the PopupMenuShowingEventArgs.Menu property.

The following code snippet illustrates how you can add a custom menu command to the context menu.

csharp
using DevExpress.XtraRichEdit.API.Native;
// ...
private void richEditControl1_PopupMenuShowing(object sender, 
        DevExpress.XtraRichEdit.PopupMenuShowingEventArgs e) {
    e.Menu.Items.Add(new DevExpress.Utils.Menu.DXMenuItem("MyMenu", 
        new EventHandler(mymenu_Click)));
}
void mymenu_Click(object sender, EventArgs e) {
    MessageBox.Show("test");
}
vb
Imports DevExpress.XtraRichEdit.API.Native
' ...
Private Sub richEditControl1_PopupMenuShowing (ByVal sender As Object, _
        ByVal e As DevExpress.XtraRichEdit.PopupMenuShowingEventArgs )
    e.Menu.Items.Add(New DevExpress.Utils.Menu.DXMenuItem("MyMenu", _
        New EventHandler(AddressOf mymenu_Click)))
End Sub
Private Sub mymenu_Click(ByVal sender As Object, ByVal e As EventArgs)
    MessageBox.Show("test")
End Sub

See Also

RichEditControl Class

RichEditControl Members

DevExpress.XtraRichEdit Namespace