SubDocument.ReplaceAll(String, String, SearchOptions, DocumentRange) Method

Finds all occurrences of the search string in the specified range, and replaces them with the replacement string.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

int ReplaceAll(
    string textToFind,
    string replaceWith,
    SearchOptions options,
    DocumentRange range
)

VB.NET

Function ReplaceAll(
    textToFind As String,
    replaceWith As String,
    options As SearchOptions,
    range As DocumentRange
) As Integer

Parameters

Name	Type	Description
textToFind	String	A string specifying the search text.
replaceWith	String	A string specifying the replacement text.
options	SearchOptions	A SearchOptions enumeration specifying search options.
range	DocumentRange	A DocumentRange object representing the range in which the search and replace is performed.

Returns

Type	Description
Int32	The number of replacements made.

Remarks

The code sample below shows how to replace “Application Programming Interface” to “API” in the document’s second section:

C#

int replacements = wordProcessor.Document.ReplaceAll("Application Programming Interface", "API", SearchOptions.WholeWord, wordProcessor.Document.Sections[1].Range);
Console.WriteLine(String.Format("The {0} replacements were made", replacements));

VB.NET

Dim replacements As Integer = wordProcessor.Document.ReplaceAll("Application Programming Interface", "API", SearchOptions.WholeWord, wordProcessor.Document.Sections(1).Range)
Console.WriteLine(String.Format("The {0} replacements were made", replacements))

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ReplaceAll(String, String, SearchOptions, DocumentRange) 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#

subdocument-essentials-simple-examples-e2265/CS/SubDocumentExample/Form1.cs#L79

string text = richEditControl1.Document.GetText(par.Range);
richEditControl1.Document.ReplaceAll("Hans", "Lucky Hans", SearchOptions.None, par.Range);
#endregion #ReplaceText

VB.NET

subdocument-essentials-simple-examples-e2265/VB/SubDocumentExample/Form1.vb#L74

            Dim text_Renamed As String = richEditControl1.Document.GetText(par.Range)
            richEditControl1.Document.ReplaceAll("Hans", "Lucky Hans", SearchOptions.None, par.Range)
'            #End Region ' #ReplaceText