Article
11/17/2011

String.Replace Method (String, String)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Returns a new string in which all occurrences of a specified string in the current string are replaced with another specified string.

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

Syntax

'Declaration
Public Function Replace ( _
    oldValue As String, _
    newValue As String _
) As String

public string Replace(
    string oldValue,
    string newValue
)

Parameters

oldValue
Type: System.String
A string to be replaced.

newValue
Type: System.String
A string to replace all occurrences of oldValue.

Return Value

Type: System.String
A string that is equivalent to the current string except that all instances of oldValue are replaced with newValue.

Exceptions

Exception	Condition
ArgumentNullException	oldValue is nulla null reference (Nothing in Visual Basic).
ArgumentException	oldValue is the empty string ("").

Remarks

If newValue is nulla null reference (Nothing in Visual Basic), all occurrences of oldValue are removed.

Note:
This method does not modify the value of the current instance. Instead, it returns a new string in which all occurrences of oldValue are replaced by newValue.

This method performs an ordinal (case-sensitive and culture-insensitive) search to find oldValue.

Examples

The following example demonstrates how you can use the Replace method to correct a spelling error.


Public Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim errString As String = "This docment uses 3 other docments to docment the docmentation"

      outputBlock.Text &= String.Format("The original string is:{0}'{1}'{0}", vbCrLf, errString) & vbCrLf

      ' Correct the spelling of "document".  
      Dim correctString As String = errString.Replace("docment", "document")

      outputBlock.Text &= String.Format("After correcting the string, the result is:{0}'{1}'", vbCrLf, correctString) & vbCrLf
   End Sub
End Class
'
' This code example produces the following output:
'
' The original string is:
' 'This docment uses 3 other docments to docment the docmentation'
'
' After correcting the string, the result is:
' 'This document uses 3 other documents to document the documentation'
'

using System;

public class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {

      string errString = "This docment uses 3 other docments to docment the docmentation";

      outputBlock.Text += String.Format("The original string is:{0}'{1}'{0}", "\n", errString) + "\n";

      // Correct the spelling of "document".

      string correctString = errString.Replace("docment", "document");

      outputBlock.Text += String.Format("After correcting the string, the result is:{0}'{1}'",
              "\n", correctString) + "\n";
   }
}
//
// This code example produces the following output:
//
// The original string is:
// 'This docment uses 3 other docments to docment the docmentation'
//
// After correcting the string, the result is:
// 'This document uses 3 other documents to document the documentation'
//

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Share via