Export (0) Print
Expand All

SortKey.Equals Method

Determines whether the specified object is equal to the current SortKey object.

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

public override bool Equals(
	Object value
)

Parameters

value
Type: System.Object

The object to compare with the current SortKey object.

Return Value

Type: System.Boolean
true if the value parameter is equal to the current SortKey object; otherwise, false.

ExceptionCondition
ArgumentNullException

value is null.

Two SortKey objects are considered equal if their KeyData properties are equal.

This method overrides Object.Equals.

The following code example shows the results of Equals when compared with different SortKey objects.

using System;
using System.Globalization;


public class SamplesSortKey  {

   public static void Main()  {

      // Creates two identical en-US cultures and one de-DE culture.
      CompareInfo myComp_enUS1 = new CultureInfo("en-US",false).CompareInfo;
      CompareInfo myComp_enUS2 = new CultureInfo("en-US",false).CompareInfo;
      CompareInfo myComp_deDE = new CultureInfo("de-DE",false).CompareInfo;

      // Creates the base SortKey to compare with all the others.
      SortKey mySK1 = myComp_enUS1.GetSortKey( "cant", CompareOptions.StringSort );
      // Creates a SortKey that is derived exactly the same way as the base SortKey.
      SortKey mySK2 = myComp_enUS1.GetSortKey( "cant", CompareOptions.StringSort );
      // Creates a SortKey that uses word sort, which is the default sort.
      SortKey mySK3 = myComp_enUS1.GetSortKey( "cant" );
      // Creates a SortKey for a different string.
      SortKey mySK4 = myComp_enUS1.GetSortKey( "can't", CompareOptions.StringSort );
      // Creates a SortKey from a different CompareInfo with the same culture.
      SortKey mySK5 = myComp_enUS2.GetSortKey( "cant", CompareOptions.StringSort );
      // Creates a SortKey from a different CompareInfo with a different culture.
      SortKey mySK6 = myComp_deDE.GetSortKey( "cant", CompareOptions.StringSort );

      // Compares the base SortKey with itself.
      Console.WriteLine( "Comparing the base SortKey with itself: {0}", mySK1.Equals( mySK1 ) );
      Console.WriteLine();

      // Prints the header for the table.
      Console.WriteLine( "CompareInfo   Culture      OriginalString   CompareOptions   Equals()" );

      // Compares the base SortKey with a SortKey that is 
      //    created from the same CompareInfo with the same string and the same CompareOptions.
      Console.WriteLine( "same          same         same             same             {0}", mySK1.Equals( mySK2 ) );

      // Compares the base SortKey with a SortKey that is  
      //    created from the same CompareInfo with the same string but with different CompareOptions.
      Console.WriteLine( "same          same         same             different        {0}", mySK1.Equals( mySK3 ) );

      // Compares the base SortKey with a SortKey that is  
      //    created from the same CompareInfo with the different string  
      //    but with the same CompareOptions.
      Console.WriteLine( "same          same         different        same             {0}", mySK1.Equals( mySK4 ) );

      // Compares the base SortKey with a SortKey that is  
      //    created from a different CompareInfo (same culture)  
      //    with the same string and the same CompareOptions.
      Console.WriteLine( "different     same         same             same             {0}", mySK1.Equals( mySK5 ) );

      // Compares the base SortKey with a SortKey that is  
      //    created from a different CompareInfo (different culture)  
      //    with the same string and the same CompareOptions.
      Console.WriteLine( "different     different    same             same             {0}", mySK1.Equals( mySK6 ) );

   }

}

/*
This code produces the following output.

Comparing the base SortKey with itself: True

CompareInfo   Culture      OriginalString   CompareOptions   Equals()
same          same         same             same             True
same          same         same             different        False
same          same         different        same             False
different     same         same             same             True
different     different    same             same             False

*/

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft