Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

StringComparer.Create Method

Creates a StringComparer object that compares strings according to the rules of a specified culture.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
'Declaration
Public Shared Function Create ( _
	culture As CultureInfo, _
	ignoreCase As Boolean _
) As StringComparer

Parameters

culture
Type: System.Globalization.CultureInfo

A culture whose linguistic rules are used to perform a string comparison.

ignoreCase
Type: System.Boolean

true to specify that comparison operations be case-insensitive; false to specify that comparison operations be case-sensitive.

Return Value

Type: System.StringComparer
A new StringComparer object that performs string comparisons according to the comparison rules used by the culture parameter and the case rule specified by the ignoreCase parameter.
ExceptionCondition
ArgumentNullException

culture is Nothing.

The following code example demonstrates the properties and the Create method of the StringComparer class. The example illustrates how different StringComparer objects sort three versions of the Latin letter I.

' This code example demonstrates members of the System.StringComparer class. 

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Globalization
Imports System.Threading

Class Sample

    Public Shared Sub Main() 
        ' Create a list of string. 
        Dim list As New List(Of String) 

        ' Get the tr-TR (Turkish-Turkey) culture. 
        Dim turkish As New CultureInfo("tr-TR")

        ' Get the culture that is associated with the current thread. 
        Dim thisCulture As CultureInfo = Thread.CurrentThread.CurrentCulture

        ' Get the standard StringComparers. 
        Dim invCmp As StringComparer = StringComparer.InvariantCulture
        Dim invICCmp As StringComparer = StringComparer.InvariantCultureIgnoreCase
        Dim currCmp As StringComparer = StringComparer.CurrentCulture
        Dim currICCmp As StringComparer = StringComparer.CurrentCultureIgnoreCase
        Dim ordCmp As StringComparer = StringComparer.Ordinal
        Dim ordICCmp As StringComparer = StringComparer.OrdinalIgnoreCase

        ' Create a StringComparer that uses the Turkish culture and ignores case. 
        Dim turkICComp As StringComparer = StringComparer.Create(turkish, True)

        ' Define three strings consisting of different versions of the letter I. 
        ' LATIN CAPITAL LETTER I (U+0049) 
        Dim capitalLetterI As String = "I" 

        ' LATIN SMALL LETTER I (U+0069) 
        Dim smallLetterI As String = "i" 

        ' LATIN SMALL LETTER DOTLESS I (U+0131) 
        Dim smallLetterDotlessI As String = "ı" 

        ' Add the three strings to the list.
        list.Add(capitalLetterI)
        list.Add(smallLetterI)
        list.Add(smallLetterDotlessI)

        ' Display the original list order.
        Display(list, "The original order of the list entries...")

        ' Sort the list using the invariant culture.
        list.Sort(invCmp)
        Display(list, "Invariant culture...")
        list.Sort(invICCmp)
        Display(list, "Invariant culture, ignore case...")

        ' Sort the list using the current culture.
        Console.WriteLine("The current culture is ""{0}"".", thisCulture.Name)
        list.Sort(currCmp)
        Display(list, "Current culture...")
        list.Sort(currICCmp)
        Display(list, "Current culture, ignore case...")

        ' Sort the list using the ordinal value of the character code points.
        list.Sort(ordCmp)
        Display(list, "Ordinal...")
        list.Sort(ordICCmp)
        Display(list, "Ordinal, ignore case...")

        ' Sort the list using the Turkish culture, which treats LATIN SMALL LETTER  
        ' DOTLESS I differently than LATIN SMALL LETTER I.
        list.Sort(turkICComp)
        Display(list, "Turkish culture, ignore case...")

    End Sub 'Main

    Public Shared Sub Display(ByVal lst As List(Of String), ByVal title As String)
        Dim c As Char 
        Dim s As String 
        Dim codePoint As Integer

        Console.WriteLine(title)
        For Each s In lst
            c = s(0)
            codePoint = Convert.ToInt32(c)
            Console.WriteLine("0x{0:x}", codePoint)
        Next s
        Console.WriteLine()
    End Sub 'Display
End Class 'Sample '

'This code example produces the following results: 

'The original order of the list entries... 
'0x49 
'0x69 
'0x131 

'Invariant culture... 
'0x69 
'0x49 
'0x131 

'Invariant culture, ignore case... 
'0x49 
'0x69 
'0x131 

'The current culture is "en-US". 
'Current culture... 
'0x69 
'0x49 
'0x131 

'Current culture, ignore case... 
'0x49 
'0x69 
'0x131 

'Ordinal... 
'0x49 
'0x69 
'0x131 

'Ordinal, ignore case... 
'0x69 
'0x49 
'0x131 

'Turkish culture, ignore case... 
'0x131 
'0x49 
'0x69 
'

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.