• Article

String.Remove Method (Int32)

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

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)

Syntax

'Declaration
Public Function Remove ( _
    startIndex As Integer _
) As String

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.

Exceptions

Exception Condition
ArgumentOutOfRangeException

startIndex is less than zero.

-or-

startIndex specifies a position that is not within this string.

Remarks

In the .NET Framework for Silverlight, 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.

Examples

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.

Class Example
   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim s As String = "abc---def"
      '
      outputBlock.Text &= "Index: 012345678" & vbCrLf
      outputBlock.Text += String.Format("1)     {0}", s) & vbCrLf
      outputBlock.Text += String.Format("2)     {0}", s.Remove(3)) & vbCrLf
      outputBlock.Text += String.Format("3)     {0}", s.Remove(3, 3)) & vbCrLf
   End Sub 'Main
End Class 'Sample
'
'This example produces the following results:
'
'Index: 012345678
'1)     abc---def
'2)     abc
'3)     abcdef
'

// 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

*/

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.