String.StartsWith Method (String)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

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

Syntax

Public Function StartsWith ( _
    value As String _
) As Boolean
public bool StartsWith(
    string value
)

Parameters

Return Value

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

Exceptions

Exception Condition
ArgumentNullException

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

Remarks

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 (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.

Examples

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


Public Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim strSource As 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"}

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

      outputBlock.Text &= "The following lists the items before the tags have been stripped:" & vbCrLf
      outputBlock.Text &= "-----------------------------------------------------------------" & vbCrLf

      ' print out the initial array of strings
      Dim s As String
      For Each s In strSource
         outputBlock.Text &= s & vbCrLf
      Next s

      outputBlock.Text &= vbCrLf

      outputBlock.Text &= "The following lists the items after the tags have been stripped:" & vbCrLf
      outputBlock.Text &= "----------------------------------------------------------------" & vbCrLf

      ' print out the array of strings
      For Each s In strSource
         outputBlock.Text &= StripStartTags(s) & vbCrLf
      Next s

   End Sub 'Main

   Private Shared Function StripStartTags(ByVal item As String) As String

      ' try to find a tag at the start of the line using StartsWith
      If item.Trim().StartsWith("<") Then

         ' now search for the closing tag...
         Dim lastLocation As Integer = item.IndexOf(">")

         If lastLocation >= 0 Then
            ' remove the identified section, if it is a valid region
            item = item.Substring((lastLocation + 1))
         End If
      End If

      Return item

   End Function 'StripStartTags

End Class 'EndsWithTest
using System;

public class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {

      // 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" };

      outputBlock.Text += "The following lists the items before the tags have been stripped:" + "\n";
      outputBlock.Text += "-----------------------------------------------------------------" + "\n";

      // print out the initial array of strings
      foreach (string s in strSource)
         outputBlock.Text += s + "\n";

      outputBlock.Text += "\n";

      outputBlock.Text += "The following lists the items after the tags have been stripped:" + "\n";
      outputBlock.Text += "----------------------------------------------------------------" + "\n";

      // print out the array of strings
      foreach (string s in strSource)
         outputBlock.Text += StripStartTags(s) + "\n";
   }

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

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

String Class

StartsWith Overload

System Namespace

EndsWith