Export (0) Print
Expand All
Expand Minimize
1 out of 4 rated this helpful - Rate this topic

StringComparison Enumeration

Updated: January 2012

Specifies the culture, case, and sort rules to be used by certain overloads of the String.Compare and String.Equals methods.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
[SerializableAttribute]
[ComVisibleAttribute(true)]
public enum StringComparison
Member nameDescription
Supported by the XNA FrameworkSupported by Portable Class LibraryCurrentCultureCompare strings using culture-sensitive sort rules and the current culture.
Supported by the XNA FrameworkSupported by Portable Class LibraryCurrentCultureIgnoreCaseCompare strings using culture-sensitive sort rules, the current culture, and ignoring the case of the strings being compared.
Supported by the XNA FrameworkInvariantCultureCompare strings using culture-sensitive sort rules and the invariant culture.
Supported by the XNA FrameworkInvariantCultureIgnoreCaseCompare strings using culture-sensitive sort rules, the invariant culture, and ignoring the case of the strings being compared.
Supported by the XNA FrameworkSupported by Portable Class LibraryOrdinalCompare strings using ordinal sort rules.
Supported by the XNA FrameworkSupported by Portable Class LibraryOrdinalIgnoreCaseCompare strings using ordinal sort rules and ignoring the case of the strings being compared.

The StringComparison enumeration is used to specify whether a string comparison should use the current culture or the invariant culture, word or ordinal sort rules, and be case-sensitive or case-insensitive.

Important noteImportant

When you call a string comparison method such as String.Compare, String.Equals, or String.IndexOf, you should always call an overload that includes a parameter of type StringComparison so that you can specify the type of comparison that the method performs. For more information, see Best Practices for Using Strings in the .NET Framework.

An operation that uses word sort rules performs a culture-sensitive comparison wherein certain nonalphanumeric Unicode characters might have special weights assigned to them. Using word sort rules and the conventions of a specific culture, the hyphen ("-") might have a very small weight assigned to it so that "coop" and "co-op" appear next to each other in a sorted list.

An operation that uses ordinal sort rules performs a comparison based on the numeric value (Unicode code point) of each Char in the string. An ordinal comparison is fast but culture-insensitive. When you use ordinal sort rules to sort strings that start with Unicode characters (U+), the string U+xxxx comes before the string U+yyyy if the value of xxxx is numerically less than yyyy.

For more information about comparisons, see the System.String class remarks. For more information about culture, see the System.Globalization.CultureInfo class remarks. For guidelines on when to use ordinal or culture-sensitive comparison rules or the rules of the invariant culture, see Best Practices for Using Strings in the .NET Framework.

.NET Framework

Supported in: 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

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Date

History

Reason

January 2012

Added an alert to the Remarks section.

Information enhancement.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.