SubDocument.FindAll(String, SearchOptions) Method

Finds all text ranges that match the specified string in the current document.

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#

DocumentRange[] FindAll(
    string textToFind,
    SearchOptions options
)

VB.NET

Function FindAll(
    textToFind As String,
    options As SearchOptions
) As DocumentRange()

Parameters

Name	Type	Description
textToFind	String	A string, specifying the search text.
options	SearchOptions	A SearchOptions enumeration specifying search options.

Returns

Type	Description
DocumentRange[]	An array of DocumentRange objects representing matching text ranges.

Remarks

The code sample below shows how to find a word “letter”:

C#

DocumentRange[] found = wordProcessor.Document.FindAll("letter", SearchOptions.WholeWord);

VB.NET

Dim found As DocumentRange() = wordProcessor.Document.FindAll("letter", SearchOptions.WholeWord)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FindAll(String, SearchOptions) 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-the-richeditcontrols-common-api-t210437/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L48

RichEditControl richEdit = e.Item.Tag as RichEditControl;
DocumentRange[] buttonWordRanges = richEdit.Document.FindAll("button", SearchOptions.None);
richEdit.Document.Selection = buttonWordRanges[0];

how-to-create-nested-fields-programmatically-e4004/CS/Form1.cs#L20

DocumentRange[] dvFieldRanges = richEditControl1.Document.FindAll(fields, DevExpress.XtraRichEdit.API.Native.SearchOptions.None);

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

    options |= DevExpress.XtraRichEdit.API.Native.SearchOptions.CaseSensitive;
DocumentRange[] ranges = Control.Document.FindAll(text, options);
if(ranges != null && ranges.Length > 0) {

bookmarks-and-hyperlinks-simple-example-t548777/CS/BookmarksAndHyperlinksSimpleExample/Form1.cs#L58

//Insert the hyperlink anchored to the created bookmark:
DocumentRange[] foundRanges = document.FindAll("To the Top", SearchOptions.CaseSensitive);
if (foundRanges.Length > 0)

bookmarks-and-hyperlinks-simple-example-t549304/CS/BookmarksAndHyperlinksSimpleExample/MainWindow.xaml.cs#L52

//Insert the hyperlink anchored to the created bookmark:
DocumentRange[] foundRanges = document.FindAll("To the Top", SearchOptions.CaseSensitive);
if (foundRanges.Length > 0)

VB.NET

winforms-the-richeditcontrols-common-api-t210437/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L53

Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
Dim buttonWordRanges() As DocumentRange = richEdit.Document.FindAll("button", SearchOptions.None)
richEdit.Document.Selection = buttonWordRanges(0)

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

End If
Dim ranges() As DocumentRange = Control.Document.FindAll(text, options)
If ranges IsNot Nothing AndAlso ranges.Length > 0 Then

bookmarks-and-hyperlinks-simple-example-t548777/VB/BookmarksAndHyperlinksSimpleExample/Form1.vb#L55

'Insert the hyperlink anchored to the created bookmark:
Dim foundRanges() As DocumentRange = document.FindAll("To the Top", SearchOptions.CaseSensitive)
If foundRanges.Length > 0 Then

bookmarks-and-hyperlinks-simple-example-t549304/VB/BookmarksAndHyperlinksSimpleExample/MainWindow.xaml.vb#L49

'Insert the hyperlink anchored to the created bookmark:
Dim foundRanges() As DocumentRange = document.FindAll("To the Top", SearchOptions.CaseSensitive)
If foundRanges.Length > 0 Then

using-the-search-and-replace-api-functionality-e1677/VB/SearchAndReplaceExample/Form1.vb#L95

End If
Dim ranges As DocumentRange() = Document.FindAll(Me.searchString, options)
XtraMessageBox.Show(String.Format("{0} matches were found.", ranges.Length), Application.ProductName)