ShowFormEventArgs.Handled Property

Gets or sets whether an event was handled. If it was handled, the default actions are not required.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

public bool Handled { get; set; }

VB.NET

Public Property Handled As Boolean

Property Value

Type	Description
Boolean	true if it was handled and the default dialog doesn’t need to be shown; otherwise, false.

Remarks

If the event parameter’s Handled property is set to true within a handler, then the default dialog will not be shown. Otherwise, the default dialog will be invoked after the custom actions within the handler have been performed.

Use the Handled property set to true with the ShowFormEventArgs.DialogResult parameter, to substitute a standard dialog with a custom one.

Example

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

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-dialog-forms-in-xtrarichedit-suite-e3095

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 Handled property.

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-customize-dialog-forms-in-xtrarichedit-suite-e3095/CS/CustomDialogs/Form1.cs#L25

    e.DialogResult = form.ShowDialog();
    e.Handled = true;
}

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

void richEditControl1_SearchFormShowing(object sender, SearchFormShowingEventArgs e) {
    e.Handled = true;
    CustomSearchForm form = new CustomSearchForm(e.ControllerParameters);

VB.NET

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

    e.DialogResult = form.ShowDialog()
    e.Handled = True
End Sub

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

Private Sub richEditControl1_SearchFormShowing(ByVal sender As Object, ByVal e As SearchFormShowingEventArgs)
    e.Handled = True
    Dim form As New CustomSearchForm(e.ControllerParameters)