RichEditControl.ShowReplaceForm() Method

Invokes the SearchForm dialog switched to the Replace tab.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

Declaration

C#

public virtual void ShowReplaceForm()

VB.NET

Public Overridable Sub ShowReplaceForm

Remarks

Use the ReplaceCommand to achieve the same result.

Example

The following code invokes the Find and Replace dialog switched to the ‘Replace’ tab and highlights all occurrences of the word ‘button’ in a document. The current RichEditControl instance is passed to the BarItem.ItemClick event handler using the BarItem.Tag property.

View Example

RichEditControlActions.cs

static void buttonCustomAction_ItemClick_ShowReplaceFormMethod(object sender, ItemClickEventArgs e) {
    RichEditControl richEdit = e.Item.Tag as RichEditControl;
    DocumentRange[] buttonWordRanges = richEdit.Document.FindAll("button", SearchOptions.None);
    richEdit.Document.Selection = buttonWordRanges[0];
    richEdit.ShowReplaceForm();
}

RichEditControlActions.vb

Private Shared Sub buttonCustomAction_ItemClick_ShowReplaceFormMethod(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
    Dim buttonWordRanges() As DocumentRange = richEdit.Document.FindAll("button", SearchOptions.None)
    richEdit.Document.Selection = buttonWordRanges(0)
    richEdit.ShowReplaceForm()
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShowReplaceForm() method.

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#

winforms-richeditcontrol-common-api/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L50

    richEdit.Document.Selection = buttonWordRanges[0];
    richEdit.ShowReplaceForm();
}

VB.NET

winforms-richeditcontrol-common-api/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L55

    richEdit.Document.Selection = buttonWordRanges(0)
    richEdit.ShowReplaceForm()
End Sub