RichEditControl.SearchFormShowing Event

Occurs when a search form is invoked before it is displayed.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.2.dll

NuGet Package: DevExpress.Win.RichEdit

Declaration

C#

public event SearchFormShowingEventHandler SearchFormShowing

VB.NET

Public Event SearchFormShowing As SearchFormShowingEventHandler

Event Data

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

Property	Description
ActivePage	Obtains what tab of the Find and Replace dialog (Find or Replace) is active.
ControllerParameters	Gets the information for initializing the Find and Replace dialog controls.
DialogResult	Gets or sets the return value of a dialog box. Inherited from ShowFormEventArgs.
Handled	Gets or sets whether an event was handled. If it was handled, the default actions are not required. Inherited from ShowFormEventArgs.
Parent	Gets or sets a parent of the form being shown. Inherited from ShowFormEventArgs.

Remarks

Handle the SearchFormShowing event to perform the required actions before a search form is displayed. Use the SearchFormShowingEventArgs.ActivePage property of the event’s argument to determine what tab is active on the search form - Find or Replace.

Note

The RichEditControl.ShowSearchForm and RichEditControl.ShowReplaceForm methods trigger the SearchFormShowing event.

Example

This example demonstrates how to replace the standard Find and Replace dialog with a custom one via the RichEditControl.SearchFormShowing event.

View Example

Form1.cs

private void richEditControl1_SearchFormShowing(object sender, SearchFormShowingEventArgs e)
{
    string curWord = richEditControl1.Document.GetText(richEditControl1.Document.Selection);
    MySearchTextForm form = new MySearchTextForm(e.ControllerParameters, curWord);
    e.DialogResult = form.ShowDialog();
    e.Handled = true;
}

MySearchForm.cs

using System.Drawing;
using DevExpress.XtraRichEdit.Forms;

namespace CustomDialogs
{
    public partial class MySearchTextForm : SearchTextForm
    {
        public MySearchTextForm(SearchFormControllerParameters controllerParameters, string searchWord)
            : base(controllerParameters)
        {
            lblFndDirection.Location = new Point (lblFndDirection.Location.X - 10, lblFndDirection.Location.Y);
            lblFndDirection.Text = "Direction:";
            cbFndSearchString.Text = searchWord;
            chbFndRegex.Enabled = false;
        }

    }
}

MySearchForm.vb

Imports Microsoft.VisualBasic
Imports System.Drawing
Imports DevExpress.XtraRichEdit.Forms

Namespace CustomDialogs
    Partial Public Class MySearchTextForm
        Inherits SearchTextForm
        Public Sub New(ByVal controllerParameters As SearchFormControllerParameters, ByVal searchWord As String)
            MyBase.New(controllerParameters)
            lblFndDirection.Location = New Point (lblFndDirection.Location.X - 10, lblFndDirection.Location.Y)
            lblFndDirection.Text = "Direction:"
            cbFndSearchString.Text = searchWord
            chbFndRegex.Enabled = False
        End Sub
    End Class
End Namespace

Form1.vb

Private Sub richEditControl1_SearchFormShowing(ByVal sender As Object, ByVal e As SearchFormShowingEventArgs) Handles richEditControl1.SearchFormShowing
    Dim curWord As String = richEditControl1.Document.GetText(richEditControl1.Document.Selection)
    Dim form As New MySearchTextForm(e.ControllerParameters, curWord)
    e.DialogResult = form.ShowDialog()
    e.Handled = True
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SearchFormShowing event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-highlight-all-found-word-entries-in-a-document-t202228/CS/RichEdit/Form1.cs#L18

    this.richEditControl1.CustomMarkDraw += richEditControl1_CustomMarkDraw;
    this.richEditControl1.SearchFormShowing += richEditControl1_SearchFormShowing;
}

VB.NET

how-to-customize-dialog-forms-in-xtrarichedit-suite-e3095/VB/CustomDialogs/Form1.vb#L19

#Region "#SearchFormShowing"
Private Sub richEditControl1_SearchFormShowing(ByVal sender As Object, ByVal e As SearchFormShowingEventArgs) Handles richEditControl1.SearchFormShowing
    Dim curWord As String = richEditControl1.Document.GetText(richEditControl1.Document.Selection)

how-to-highlight-all-found-word-entries-in-a-document-t202228/VB/RichEdit/Form1.vb#L20

    AddHandler Me.richEditControl1.CustomMarkDraw, AddressOf richEditControl1_CustomMarkDraw
    AddHandler Me.richEditControl1.SearchFormShowing, AddressOf richEditControl1_SearchFormShowing
End Sub