StringComparer.CurrentCultureIgnoreCase Property

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

Gets a StringComparer object that performs case-insensitive string comparisons using the word comparison rules of the current culture.

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

Syntax

Public Shared ReadOnly Property CurrentCultureIgnoreCase As StringComparer
public static StringComparer CurrentCultureIgnoreCase { get; }

Property Value

Type: System..::.StringComparer
A new StringComparer object.

Remarks

The current culture is the CultureInfo object associated with the current thread.

The StringComparer returned by the CurrentCultureIgnoreCase property can be used when strings are linguistically relevant but their case is not. For example, if strings are displayed to the user but case is unimportant, culture-sensitive, case-insensitive string comparison should be used to order the string data.

The CurrentCultureIgnoreCase property actually returns an instance of an anonymous class derived from the StringComparer class.

Each call to the CurrentCultureIgnoreCase property get accessor returns a new StringComparer object, as the following code shows.

Private Sub CompareCurrentCultureInsensitiveStringComparers(ByVal outputBlock As System.Windows.Controls.TextBlock)
   Dim stringComparer1, stringComparer2 As StringComparer
   stringComparer1 = StringComparer.CurrentCultureIgnoreCase
   stringComparer2 = StringComparer.CurrentCultureIgnoreCase
   ' Displays False
   outputBlock.Text += StringComparer.ReferenceEquals(stringComparer1, _
                                                    stringComparer2) & vbCrLf
End Sub
private void CompareCurrentCultureInsensitiveStringComparer(System.Windows.Controls.TextBlock outputBlock)
{
   StringComparer stringComparer1, stringComparer2;
   stringComparer1 = StringComparer.CurrentCultureIgnoreCase;
   stringComparer2 = StringComparer.CurrentCultureIgnoreCase;
   // Displays false
   outputBlock.Text += StringComparer.ReferenceEquals(stringComparer1,
                                                    stringComparer2) + "\n";
}

To improve performance, you can store the StringComparer object in a local variable rather than retrieve the value of the CurrentCultureIgnoreCase property multiple times.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

StringComparer Class

System Namespace