SubDocument.FindAll(String, SearchOptions, DocumentRange) Method

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

DocumentRange[] FindAll(
    string textToFind,
    SearchOptions options,
    DocumentRange range
)

VB.NET

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

Parameters

Name	Type	Description
textToFind	String	A string, specifying the search text.
options	SearchOptions	A SearchOptions enumeration specifying search options.
range	DocumentRange	A DocumentRange object specifying the range in the document in which a search is performed.

Returns

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

Example

This code snippet illustrates how a document range is searched for the emoticon, and the emoticon, if found, is replaced with a smiley image.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/dxrichedit-for-wpf-how-to-customize-the-hover-menu-e2753

MySmileyCommand.vb

Dim doc As Document = Control.Document
Dim range As DocumentRange = doc.Selection
Dim smileyRanges() As DocumentRange = doc.FindAll(":-)", SearchOptions.WholeWord, range)
For Each r As DocumentRange In smileyRanges
    doc.Delete(r)
    doc.InsertImage(r.Start, smile)
Next r

MySmileyCommand.cs

Document doc = Control.Document;
DocumentRange range = doc.Selection;
DocumentRange[] smileyRanges = doc.FindAll(":-)", SearchOptions.WholeWord, range);
foreach (DocumentRange r in smileyRanges) {
    doc.Delete(r);
    doc.InsertImage(r.Start, smile);
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FindAll(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#

dxrichedit-for-wpf-how-to-customize-the-hover-menu-e2753/CS/DXRichEdit_HoverMenu/MySmileyCommand.cs#L88

DocumentRange range = doc.Selection;
DocumentRange[] smileyRanges = doc.FindAll(":-)", SearchOptions.WholeWord, range);
foreach (DocumentRange r in smileyRanges) {

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/CommentsActions.cs#L30

if (document.Comments.Count > 0) {
    DocumentRange[] resRanges = document.FindAll("trump", SearchOptions.None, document.Comments[1].Range);
    if (resRanges.Length > 0) {

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Comments.cs#L22

if (document.Comments.Count > 0) {
    DocumentRange[] resRanges = document.FindAll("trump", SearchOptions.None, document.Comments[1].Range);
    if (resRanges.Length > 0) {

word-document-api-examples/CS/CodeExamples/CommentsActions.cs#L31

{
    DocumentRange[] resRanges = document.FindAll("trump", SearchOptions.None, document.Comments[1].Range);
    if (resRanges.Length > 0)

VB.NET

dxrichedit-for-wpf-how-to-customize-the-hover-menu-e2753/VB/DXRichEdit_HoverMenu/MySmileyCommand.vb#L81

Dim range As DocumentRange = doc.Selection
Dim smileyRanges() As DocumentRange = doc.FindAll(":-)", SearchOptions.WholeWord, range)
For Each r As DocumentRange In smileyRanges

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/CommentsActions.vb#L28

If document.Comments.Count > 0 Then
    Dim resRanges() As DocumentRange = document.FindAll("trump", SearchOptions.None, document.Comments(1).Range)
    If resRanges.Length > 0 Then

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Comments.vb#L20

If document.Comments.Count > 0 Then
    Dim resRanges() As DocumentRange = document.FindAll("trump", SearchOptions.None, document.Comments(1).Range)
    If resRanges.Length > 0 Then

word-document-api-examples/VB/CodeExamples/CommentsActions.vb#L26

If document.Comments.Count > 0 Then
    Dim resRanges() As DocumentRange = document.FindAll("trump", SearchOptions.None, document.Comments(1).Range)
    If resRanges.Length > 0 Then