SubDocument.FindAll(String, SearchOptions) Method

Finds all text ranges that match the specified string in the specific part of the document (main body, text box, header, footer, comment, footnote, and endnote).

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

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)

The SubDocument.FindAll method overload performs a search in a specific document part (main body, text box, header, footer, comment, footnote, or endnote). Iterate all document parts and call the SubDocument.FindAll method for each SubDocument to search throughout all document parts. Refer to the following example for a code snippet on how to iterate all sub-documents: How to Iterate through all Sub-documents in a Document

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-richeditcontrol-common-api/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];

reporting-winforms-change-formatting-xrrichtext-rtf-content/CS/XtraReport1.cs#L48

// Remove whitespaces from the end of RTF content
DocumentRange[] dots = server.Document.FindAll(".", SearchOptions.None);
DocumentPosition lastDot = dots[dots.Length - 1].End;

winforms-richedit-remove-an-empty-paragraph-when-appending-a-content/CS/Form1.cs#L52

DocumentRange[] par = richEditControl1.Document.FindAll("\r", SearchOptions.None);

winforms-grid-richedit-highlight-search-results/CS/E4422/Form1.cs#L23

document.BeginUpdate();
DocumentRange[] ranges = document.FindAll(gridView1.FindFilterText, SearchOptions.None);
for (int i = 0; i < ranges.Length; i++) {

winforms-reporting-xrrichtext-insert-a-page-break-from-rtf-contents/CS/WindowsFormsApplication1/Form1.cs#L22

server.LoadDocument("fish.rtf");
DocumentRange[] ranges = server.Document.FindAll(DevExpress.Office.Characters.PageBreak.ToString(), DevExpress.XtraRichEdit.API.Native.SearchOptions.None);
DocumentPosition dp = server.Document.Paragraphs[0].Range.Start;

VB.NET

winforms-richeditcontrol-common-api/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)

reporting-winforms-change-formatting-xrrichtext-rtf-content/VB/XtraReport1.vb#L52

' Remove whitespaces from the end of RTF content
Dim dots() As DocumentRange = server.Document.FindAll(".", SearchOptions.None)
Dim lastDot As DocumentPosition = dots(dots.Length - 1).End

winforms-richedit-remove-an-empty-paragraph-when-appending-a-content/VB/Form1.vb#L50

richEditControl1.Document.AppendRtfText(File.ReadAllText("sample1.rtf"))
Dim par As DocumentRange() = richEditControl1.Document.FindAll(Microsoft.VisualBasic.Constants.vbCr, SearchOptions.None)
If par.Length > 0 Then richEditControl1.Document.Replace(par(par.Length - 1), String.Empty)

winforms-grid-richedit-highlight-search-results/VB/E4422/Form1.vb#L26

document.BeginUpdate()
Dim ranges As DocumentRange() = document.FindAll(gridView1.FindFilterText, SearchOptions.None)
For i As Integer = 0 To ranges.Length - 1

winforms-reporting-xrrichtext-insert-a-page-break-from-rtf-contents/VB/WindowsFormsApplication1/Form1.vb#L22

server.LoadDocument("fish.rtf")
Dim ranges As DocumentRange() = server.Document.FindAll(DevExpress.Office.Characters.PageBreak.ToString(), SearchOptions.None)
Dim dp As DocumentPosition = server.Document.Paragraphs(0).Range.Start