Duration (Pacific Standard Time):
To (Pacific Standard Time):
Impact:
  • None
User Action:
  • None
.NET Framework Class Library

String.EndsWith Method (String)

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

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
Public Function EndsWith ( _
	value As String _
) As Boolean

Parameters

value
Type: System.String

The string to compare to the substring at the end of this instance.

Return Value

Type: System.Boolean
true if value matches the end of this instance; otherwise, false.
Exception Condition
ArgumentNullException

value is null.

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

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

Notes to Callers

As explained in Best Practices for Using Strings in the .NET Framework, we recommend that you avoid calling string comparison methods that substitute default values and instead call methods that require parameters to be explicitly specified. To determine whether a string ends with a particular substring by using the string comparison rules of the current culture, call the EndsWith(String, StringComparison) method overload with a value of StringComparison.CurrentCulture for its comparisonType parameter.

The following example defines a StripEndTags method that uses the EndsWith(String) method to remove HTML end tags from the end of a line. Note that the StripEndTags method is called recursively to ensure that multiple HTML end tags at the end of the line are removed.

Public Module Example
    Public Sub Main()
        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 ends with a greater than symbol, it should not be modified>" }

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

        ' Display the initial array of strings. 
        For Each s As String In  strSource
            Console.WriteLine(s)
        Next
        Console.WriteLine()

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

        ' Display the array of strings. 
        For Each s As String In strSource
            Console.WriteLine(StripEndTags(s))
        Next  
    End Sub  

    Private Function StripEndTags(item As String) As String 
        Dim found As Boolean = False 

        ' Try to find a tag at the end of the line using EndsWith. 
        If item.Trim().EndsWith(">") Then 
            ' now search for the opening tag... 
            Dim lastLocation As Integer = item.LastIndexOf("</")
            If lastLocation >= 0 Then
                found = True 

                ' Remove the identified section, if it is a valid region.
                item = item.Substring(0, lastLocation)
            End If 
        End If 

        If found Then item = StripEndTags(item)
        Return item
    End Function  
End Module 
' The example displays the following output: 
'    The following lists the items before the ends have been stripped: 
'    ----------------------------------------------------------------- 
'    <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 ends with a greater than symbol, it should not be modified> 
'     
'    The following lists the items after the ends have been stripped: 
'    ---------------------------------------------------------------- 
'    <b>This is bold text 
'    <H1>This is large Text 
'    <b><i><font color = green>This has multiple tags 
'    <b>This has <i>embedded</i> tags. 
'    This line simply ends with a greater than symbol, it should not be modified>

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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