Export (0) Print
Expand All
Expand Minimize

String.TrimStart Method

Removes all leading occurrences of a set of characters specified in an array from the current String object.

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

public string TrimStart(
	params char[] trimChars
)

Parameters

trimChars
Type: System.Char[]

An array of Unicode characters to remove or null.

Return Value

Type: System.String
The string that remains after all occurrences of characters in the trimChars parameter are removed from the start of the current String object. If trimChars is null or an empty array, white-space characters are removed instead.

The TrimStart method removes from the current string all leading characters that are in the trimChars parameter. The trim operation stops when a character that is not in trimChars is encountered. For example, if the current string is "123abc456xyz789" and trimChars contains the digits from '1' through '9', the TrimStart method returns "abc456xyz789".

NoteNote:

This method does not modify the value of the current instance. Instead, it returns a new string in which all leading white space characters found in the current instance are removed.

For more information about which Unicode characters are categorized as white-space characters, see the Remarks section of the String.Trim() method overload.

The following example uses the TrimStart method to trim white space and comment characters from lines of source code. The StripComments method wraps a call to TrimStart and passes it a character array that contains a space and the comment character (an apostrophe ( ' ) in Visual Basic and a slash ( / ) in C#). The TrimStart method is also called to remove leading white space when evaluating whether a string is a comment.

public static string[] StripComments(string[] lines)
{ 
   List<string> lineList = new List<string>();
   foreach (string line in lines)
   {
      if (line.TrimStart(' ').StartsWith("//"))
         lineList.Add(line.TrimStart(' ', '/'));
   }
   return lineList.ToArray();
}   

The following example then illustrates a call to the StripComments method.

public static void Main()
{
   string[] lines= {"using System;",
                    "", 
                    "public class HelloWorld",
                    "{", 
                    "   public static void Main()",
                    "   {", 
                    "      // This code displays a simple greeting", 
                    "      // to the console.", 
                    "      Console.WriteLine(\"Hello, World.\");", 
                    "   }", 
                    "}"};
   Console.WriteLine("Before call to StripComments:");
   foreach (string line in lines)
      Console.WriteLine("   {0}", line);                         

   string[] strippedLines = StripComments(lines); 
   Console.WriteLine("After call to StripComments:");
   foreach (string line in strippedLines)
      Console.WriteLine("   {0}", line);                         
}
// This code produces the following output to the console: 
//    Before call to StripComments: 
//       using System; 
//    
//       public class HelloWorld 
//       { 
//           public static void Main() 
//           { 
//               // This code displays a simple greeting 
//               // to the console. 
//               Console.WriteLine("Hello, World.");
//           } 
//       }   
//    After call to StripComments: 
//       This code displays a simple greeting 
//       to the console.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft