Replace(String,TextSpan) Method

Replaces a range of text in the document with a new string.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function Replace( _
   ByVal newText As String, _
   ByVal spanToReplace As TextSpan _
) As Boolean

C#

public bool Replace( 
   string newText,
   TextSpan spanToReplace
)

Parameters

newText

The new text

spanToReplace

The span of the text to replace.

Return Value

True if successful.

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 the replacementSpan. is not valid.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, 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