Back to Devexpress

RibbonControl.SearchMenuEnterPressed Event

windowsforms-devexpress-dot-xtrabars-dot-ribbon-dot-ribboncontrol-d3dd22f1.md

latest3.0 KB
Original Source

RibbonControl.SearchMenuEnterPressed Event

Occurs when a user presses Enter in the search box.

Namespace : DevExpress.XtraBars.Ribbon

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[DXCategory("Events")]
public event EventHandler<RibbonSearchMenuEnterPressedEventArgs> SearchMenuEnterPressed
vb
<DXCategory("Events")>
Public Event SearchMenuEnterPressed As EventHandler(Of RibbonSearchMenuEnterPressedEventArgs)

Event Data

The SearchMenuEnterPressed event's data class is RibbonSearchMenuEnterPressedEventArgs. The following properties provide information specific to this event:

PropertyDescription
SearchStringGets text entered in the search box. Inherited from RibbonSearchMenuBaseEventArgs.

The event data class exposes the following methods:

MethodDescription
ExecuteFirstSearchResult()Executes the action associated with the first item in the search menu.
HideSearchMenu()Hides the search menu.

Remarks

The following code snippet saves the user query, executes the first found item, and closes the Search Menu on the Enter key press:

csharp
List<string> mruStrings = new List<string>();

void ribbonControl1_SearchMenuEnterPressed(object sender, RibbonSearchMenuEnterPressedEventArgs e) {
    if (!mruStrings.Contains(e.SearchString))
        mruStrings.Insert(0, e.SearchString);
    e.ExecuteFirstSearchResult();
    e.HideSearchMenu();
}
vb
Private mruStrings As List(Of String) = New List(Of String)()

Private Sub ribbonControl1_SearchMenuEnterPressed(ByVal sender As Object, ByVal e As RibbonSearchMenuEnterPressedEventArgs)
    If Not mruStrings.Contains(e.SearchString) Then mruStrings.Insert(0, e.SearchString)
    e.ExecuteFirstSearchResult()
    e.HideSearchMenu()
End Sub

See Also

RibbonControl Class

RibbonControl Members

DevExpress.XtraBars.Ribbon Namespace