ShowFormEventArgs.DialogResult Property

Gets or sets the return value of a dialog box.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v18.2.Core.dll

Declaration

C#

public DialogResult DialogResult { get; set; }

VB.NET

Public Property DialogResult As DialogResult

Property Value

Type	Description
DialogResult	A DialogResult enumeration value that specifies the value that is returned by the dialog box.

Remarks

Use the DialogResult property with the ShowFormEventArgs.Handled parameter set to true, to change the return value of the dialog box.

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 DialogResult 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#L24

MySearchTextForm form = new MySearchTextForm(e.ControllerParameters, curWord);
e.DialogResult = form.ShowDialog();
e.Handled = true;

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

    CustomSearchForm form = new CustomSearchForm(e.ControllerParameters);
    e.DialogResult = form.ShowDialog();
}

VB.NET

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

Dim form As New MySearchTextForm(e.ControllerParameters, curWord)
e.DialogResult = form.ShowDialog()
e.Handled = True

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

    Dim form As New CustomSearchForm(e.ControllerParameters)
    e.DialogResult = form.ShowDialog()
End Sub