String.StartsWith Method (String)

Determines whether the beginning of this instance matches the specified string.

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

public bool StartsWith(
	string value
)

Parameters

value
Type: System.String

The String to compare.

Return Value

Type: System.Boolean
true if value matches the beginning of this string; otherwise, false.

ExceptionCondition
ArgumentNullException

value is null.

This method compares value to the substring at the beginning of this instance that is the same length as value, and returns an indication whether they are equal. To be equal, value must be an empty string (Empty), a reference to this same instance, or match the beginning of this instance.

This method performs a word (case-sensitive and culture-sensitive) comparison using the current culture.

The following example demonstrates how you can use the StartsWith method.

using System;

public class EndsWithTest {
    public static void Main() {

        // process a string that contains html tags 
        // this sample does not remove embedded tags (tags in the middle of a line)

        string [] strSource = { "<b>This is bold text</b>", "<H1>This is large Text</H1>",
                "<b><i><font color=green>This has multiple tags</font></i></b>",
                "<b>This has <i>embedded</i> tags.</b>",
                "<This line simply begins with a lesser than symbol, it should not be modified" };

        Console.WriteLine("The following lists the items before the tags have been stripped:");
        Console.WriteLine("-----------------------------------------------------------------");

        // print out the initial array of strings 
        foreach ( string s in strSource )
            Console.WriteLine( s );

        Console.WriteLine();

        Console.WriteLine("The following lists the items after the tags have been stripped:");
        Console.WriteLine("----------------------------------------------------------------");

        // print out the array of strings 
        foreach ( string s in strSource )
            Console.WriteLine( StripStartTags( s ) );
    }

    private static string StripStartTags( string item ) {

        // try to find a tag at the start of the line using StartsWith 
        if (item.Trim().StartsWith("<")) {

            // now search for the closing tag... 
            int lastLocation = item.IndexOf( ">" );

            // remove the identified section, if it is a valid region 
            if ( lastLocation >= 0 )
                item =  item.Substring( lastLocation + 1 );
        }

        return item;
    }
}

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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft