Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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
)
public boolean StartsWith (
	String value
)
public function StartsWith (
	value : String
) : boolean

Parameters

value

The String to compare.

Return Value

true if value matches the beginning of this string; otherwise, false.

Exception typeCondition

ArgumentNullException

value is a null reference (Nothing in Visual Basic).

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 code 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;
    }
}

import System.*;

public class EndsWithTest
{
    public static void main(String[] args)
    {
        // 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 ends have been stripped:");
        Console.WriteLine("-------------------------------------" 
            + "----------------------------");
        // print out the initial array of strings
        for (int iCtr = 0; iCtr < strSource.get_Length(); iCtr++) {
            String s = strSource[iCtr];
            Console.WriteLine(s);
        }
        Console.WriteLine();

        Console.WriteLine("The following lists the items after" 
            + " the ends have been stripped:");
        Console.WriteLine("---------------------------------------" 
            + "-------------------------");
        // print out the array of strings
        for (int iCtr = 0; iCtr < strSource.get_Length(); iCtr++) {
            String s = strSource[iCtr];
            Console.WriteLine(StripStartTags(s));
        }
    } //main

    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;
    } //StripStartTags
} //EndsWithTest

import System;

public class EndsWithTest {
    public static function Main() : void {

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

        var strSource : String [] = [ "<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
        for( var i : int in strSource )
            Console.WriteLine( strSource[i] );

        Console.WriteLine();

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

        // print out the array of strings
        for ( i in strSource )
            Console.WriteLine( StripStartTags( strSource[i] ) );
    }

    private static function StripStartTags( item : String ) : String  {

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

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

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

        return item;
    }
}
EndsWithTest.Main();

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft