FindReplace(String,TextSearchCriteria,TextSpan,Int32,Boolean) Method

Finds an instance of text in the document that matches the search criteria and replaces it with another string..

Syntax

Visual Basic

'Declaration
 
Public Overloads Function FindReplace( _
   ByVal newText As String, _
   ByVal criteria As TextSearchCriteria, _
   ByVal spanToSearch As TextSpan, _
   ByVal startOffset As Integer, _
   Optional ByVal wrapIfNotFound As Boolean _
) As TextSearchResultInfo

C#

public TextSearchResultInfo FindReplace( 
   string newText,
   TextSearchCriteria criteria,
   TextSpan spanToSearch,
   int startOffset,
   bool wrapIfNotFound
)

Parameters

newText

The new text

criteria

The search criteria

spanToSearch

The span of text to limit the search to.

startOffset

The start offset relative to the beginning of the document.

wrapIfNotFound

if true continue the search by wrapping if the end is reached without a match.

Return Value

A TextSearchResultInfo object containing the results of the operation.

Exceptions

Exception	Description
System.InvalidOperationException	If the IsReadOnly property is set to true or if this method is called in the middle of an update operation, e.g. from within a TextChanging event handler.
System.ArgumentOutOfRangeException	If startOffset is less than 0 or startOffset plus length greater than 1 minus the current length of the document.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2