String.Remove Method (Int32)

July 28, 2014

Deletes all the characters from this string beginning at a specified position and continuing through the last position.

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

public string Remove(
	int startIndex
)

Parameters

startIndex
Type: System.Int32
The zero-based position to begin deleting characters.

Return Value

Type: System.String
A new string that is equivalent to this string without the removed characters.

ExceptionCondition
ArgumentOutOfRangeException

startIndex is less than zero.

-or-

startIndex specifies a position that is not within this string.

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 all characters from position startIndex to the end of the original string have been removed.

The following code example demonstrates the Remove method. The next-to-last case removes all text starting from the specified index through the end of the string. The last case removes three characters starting from the specified index.


// This example demonstrates the String.Remove() method.
using System;

class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      string s = "abc---def";
      //
      outputBlock.Text += "Index: 012345678" + "\n";
      outputBlock.Text += String.Format("1)     {0}", s) + "\n";
      outputBlock.Text += String.Format("2)     {0}", s.Remove(3)) + "\n";
      outputBlock.Text += String.Format("3)     {0}", s.Remove(3, 3)) + "\n";
   }
}
/*
This example produces the following results:

Index: 012345678
1)     abc---def
2)     abc
3)     abcdef

*/


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2014 Microsoft