String.Remove Method (Int32, Int32)

Deletes a specified number of characters from this instance beginning at a specified position.

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

Syntax

'Declaration
<SecuritySafeCriticalAttribute> _
Public Function Remove ( _
    startIndex As Integer, _
    count As Integer _
) As String
[SecuritySafeCriticalAttribute]
public string Remove(
    int startIndex,
    int count
)

Parameters

  • startIndex
    Type: System.Int32
    The zero-based position to begin deleting characters.
  • count
    Type: System.Int32
    The number of characters to delete.

Return Value

Type: System.String
A new string that is equivalent to this instance less count number of characters.

Exceptions

Exception Condition
ArgumentOutOfRangeException

Either startIndex or count is less than zero.

-or-

startIndex plus count specify a position outside this instance.

Remarks

In the .NET Framework, strings are zero-based. The value of the startIndex parameter can range from zero to one less than the length of the string instance.

NoteNote:

This method does not modify the value of the current instance. Instead, it returns a new string in which the number of characters specified by the count parameter have been removed. The characters are removed at the position specified by startIndex.

Examples

The following code example demonstrates how you can remove the middle name from a complete name.


Public Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim name As String = "Michelle Violet Banks"

      outputBlock.Text += String.Format("The entire name is '{0}'", name) & vbCrLf
      Dim foundS1 As Integer = name.IndexOf(" ")
      Dim foundS2 As Integer = name.IndexOf(" ", foundS1 + 1)
      If foundS1 <> foundS2 And foundS1 >= 0 Then

         ' remove the middle name, identified by finding the spaces in the middle of the name...    
         name = name.Remove(foundS1 + 1, foundS2 - foundS1)

         outputBlock.Text += String.Format("After removing the middle name, we are left with '{0}'", name) & vbCrLf
      End If
   End Sub 'Main
End Class 'RemoveTest
using System;

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

      string name = "Michelle Violet Banks";

      outputBlock.Text += String.Format("The entire name is '{0}'", name) + "\n";

      // remove the middle name, identified by finding the spaces in the middle of the name...
      int foundS1 = name.IndexOf(" ");
      int foundS2 = name.IndexOf(" ", foundS1 + 1);

      if (foundS1 != foundS2 && foundS1 >= 0)
      {

         name = name.Remove(foundS1 + 1, foundS2 - foundS1);

         outputBlock.Text += String.Format("After removing the middle name, we are left with '{0}'", name) + "\n";
      }
   }
}

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.