String.TrimEnd Method

Definition

Overloads

TrimEnd()

Removes all the trailing white-space characters from the current string.

TrimEnd(Char)

Removes all the trailing occurrences of a character from the current string.

TrimEnd(Char[])

Removes all the trailing occurrences of a set of characters specified in an array from the current string.

TrimEnd()

Removes all the trailing white-space characters from the current string.

public:
 System::String ^ TrimEnd();
public string TrimEnd ();
member this.TrimEnd : unit -> string
Public Function TrimEnd () As String

Returns

The string that remains after all white-space characters are removed from the end of the current string. If no characters can be trimmed from the current instance, the method returns the current instance unchanged.

Remarks

The TrimEnd method removes from the current string all trailing white-space characters. The trim operation stops when the first non white-space character is encountered at the end of the string. For example, if the current string is " abc xyz ", the TrimEnd method returns " abc xyz".

Note

If the TrimEnd method removes any characters from the current instance, this method does not modify the value of the current instance. Instead, it returns a new string in which all trailing white-space characters are removed from the current string.

Applies to

TrimEnd(Char)

Removes all the trailing occurrences of a character from the current string.

public:
 System::String ^ TrimEnd(char trimChar);
public string TrimEnd (char trimChar);
member this.TrimEnd : char -> string
Public Function TrimEnd (trimChar As Char) As String

Parameters

trimChar
Char

A Unicode character to remove.

Returns

The string that remains after all occurrences of the trimChar character are removed from the end of the current string. If no characters can be trimmed from the current instance, the method returns the current instance unchanged.

Remarks

The TrimEnd(System.Char) method removes from the current string all trailing trimChar characters. The trim operation stops when the first character that is not trimChar is encountered at the end of the string. For example, if trimChar is - and the current string is "---abc---xyz----", the TrimEnd(System.Char) method returns "---abc---xyz".

Note

If the TrimEnd(System.Char) method removes any characters from the current instance, this method does not modify the value of the current instance. Instead, it returns a new string in which all trailing trimChar characters are removed from the current string.

Applies to

TrimEnd(Char[])

Removes all the trailing occurrences of a set of characters specified in an array from the current string.

public:
 System::String ^ TrimEnd(... cli::array <char> ^ trimChars);
public string TrimEnd (params char[] trimChars);
public string TrimEnd (params char[]? trimChars);
member this.TrimEnd : char[] -> string
Public Function TrimEnd (ParamArray trimChars As Char()) As String

Parameters

trimChars
Char[]

An array of Unicode characters to remove, or null.

Returns

The string that remains after all occurrences of the characters in the trimChars parameter are removed from the end of the current string. If trimChars is null or an empty array, Unicode white-space characters are removed instead. If no characters can be trimmed from the current instance, the method returns the current instance unchanged.

Examples

The following example demonstrates how you can use the TrimEnd(System.Char[]) method to trim white space or punctuation marks from the end of a string.

string sentence = "The dog had a bone, a ball, and other toys.";
char[] charsToTrim = {',', '.', ' '};
string[] words = sentence.Split();
foreach (string word in words)
   Console.WriteLine(word.TrimEnd(charsToTrim));

// The example displays the following output:
//       The
//       dog
//       had
//       a
//       bone
//       a
//       ball
//       and
//       other
//       toys
let sentence = "The dog had a bone, a ball, and other toys."
let charsToTrim = [| ','; '.'; ' ' |]
let words = sentence.Split()
for word in words do
    printfn $"{word.TrimEnd charsToTrim}"

// The example displays the following output:
//       The
//       dog
//       had
//       a
//       bone
//       a
//       ball
//       and
//       other
//       toys
Module TrimEnd
   Public Sub Main()
      Dim sentence As String = "The dog had a bone, a ball, and other toys."
      Dim charsToTrim() As Char = {","c, "."c, " "c}
      Dim words() As String = sentence.Split()
      For Each word As String In words
         Console.WriteLine(word.TrimEnd(charsToTrim))
      Next
   End Sub
End Module
' The example displays the following output:
'       The
'       dog
'       had
'       a
'       bone
'       a
'       ball
'       and
'       other
'       toys

Remarks

The TrimEnd(System.Char[]) method removes from the current string all trailing characters that are in the trimChars parameter. The trim operation stops when the first character that is not in trimChars is encountered at the end of the string. For example, if the current string is "123abc456xyz789" and trimChars contains the digits from "1" through "9", the TrimEnd(System.Char[]) method returns "123abc456xyz".

Note

If the TrimEnd(System.Char[]) method removes any characters from the current instance, this method does not modify the value of the current instance. Instead, it returns a new string in which all trailing characters found in trimChars are removed from the current string.

Notes to Callers

The .NET Framework 3.5 SP1 and earlier versions maintains an internal list of white-space characters that this method trims if trimChars is null or an empty array. Starting with the .NET Framework 4, if trimChars is null or an empty array, the method trims all Unicode white-space characters (that is, characters that produce a true return value when they are passed to the IsWhiteSpace(Char) method). Because of this change, the Trim() method in the .NET Framework 3.5 SP1 and earlier versions removes two characters, ZERO WIDTH SPACE (U+200B) and ZERO WIDTH NO-BREAK SPACE (U+FEFF), that the Trim() method in the .NET Framework 4 and later versions does not remove. In addition, the Trim() method in the .NET Framework 3.5 SP1 and earlier versions does not trim three Unicode white-space characters: MONGOLIAN VOWEL SEPARATOR (U+180E), NARROW NO-BREAK SPACE (U+202F), and MEDIUM MATHEMATICAL SPACE (U+205F).

See also

Applies to