RibbonControl.CustomizeSearchMenu Event

Fires when the query in the search box changes, and allows you to customize search results.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

[DXCategory("Events")]
public event RibbonSearchMenuEventHandler CustomizeSearchMenu

VB.NET

<DXCategory("Events")>
Public Event CustomizeSearchMenu As RibbonSearchMenuEventHandler

Event Data

The CustomizeSearchMenu event's data class is DevExpress.XtraBars.Ribbon.RibbonSearchMenuEventArgs.

Remarks

The CustomizeSearchMenu event fires when the query changes. The following properties provide information specific to this event:

• SearchString - gets the search query;
• Menu - gets the search menu (see PopupMenu).

The code below shows how to add a custom button to the menu.

C#

using DevExpress.XtraBars;

ribbonControl1.CustomizeSearchMenu += RibbonControl1_CustomizeSearchMenu;

BarButtonItem shareButton;
BarButtonItem ShareButton {
    get {
        if (shareButton == null) {
            BarButtonItem shareButton = new BarButtonItem();
            shareButton.Caption = "Share";
            shareButton.ItemClick += (s, ee) => MessageBox.Show("Share");
            shareButton.Manager = ribbonControl1.Manager;
            this.shareButton = shareButton;
        }
        return shareButton;
    }
}
private void ribbonControl1_CustomizeSearchMenu(object sender, DevExpress.XtraBars.Ribbon.RibbonSearchMenuEventArgs e) {
    e.Menu.AddItem(ShareButton);
}

VB.NET

Imports DevExpress.XtraBars

Private shareButton1 As BarButtonItem
Private ReadOnly Property ShareButton() As BarButtonItem
    Get
        If shareButton1 Is Nothing Then
            Dim share As New BarButtonItem()
            share.Caption = "Share"
            AddHandler share.ItemClick, Sub(s, ee) MessageBox.Show("Share")
            shareButton1.Manager = ribbonControl1.Manager
            Me.shareButton1 = share
        End If
        Return shareButton1
    End Get
End Property
Private Sub ribbonControl1_CustomizeSearchMenu(ByVal sender As Object, ByVal e As DevExpress.XtraBars.Ribbon.RibbonSearchMenuEventArgs) _
    Handles ribbonControl1.CustomizeSearchMenu
    e.Menu.AddItem(ShareButton)
End Sub