Early Preview

This is currently very much a preview. Please feel free to try things out, but don't be upset if anything is not yet working. Feedback is welcome over on our GitHub Dicussions page.

class System.​Globalization.​SortKey

Assembly: System.Runtime

Inheritance: object → SortKey

Represents the result of mapping a string to its sort key.

Properties

public byte[]
KeyData
Gets the byte array representing the current <see cref="T:System.Globalization.SortKey" /> object.
public string
OriginalString
Gets the original string used to create the current <see cref="T:System.Globalization.SortKey" /> object.

Methods

public static int
Compare​(SortKey sortkey1, SortKey sortkey2)
Compares two sort keys.
Returns A signed integer that indicates the relationship between <paramref name="sortkey1" /> and <paramref name="sortkey2" /> . <list type="table"> <listheader> <term> Value</term> <description> Condition</description> </listheader> <item> <term> Less than zero</term> <description> <paramref name="sortkey1" /> is less than <paramref name="sortkey2" />.</description> </item> <item> <term> Zero</term> <description> <paramref name="sortkey1" /> is equal to <paramref name="sortkey2" />.</description> </item> <item> <term> Greater than zero</term> <description> <paramref name="sortkey1" /> is greater than <paramref name="sortkey2" />.</description> </item> </list>
sortkey1 The first sort key to compare.
sortkey2 The second sort key to compare.
public bool
Equals​(object value)
Determines whether the specified object is equal to the current <see cref="T:System.Globalization.SortKey" /> object.
Returns <see langword="true" /> if the <paramref name="value" /> parameter is equal to the current <see cref="T:System.Globalization.SortKey" /> object; otherwise, <see langword="false" /> .
value The object to compare with the current <see cref="T:System.Globalization.SortKey" /> object.
public int
GetHashCode​()
Serves as a hash function for the current <see cref="T:System.Globalization.SortKey" /> object that is suitable for hashing algorithms and data structures such as a hash table.
Returns A hash code for the current <see cref="T:System.Globalization.SortKey" /> object.
public string
ToString​()
Returns a string that represents the current <see cref="T:System.Globalization.SortKey" /> object.
Returns A string that represents the current <see cref="T:System.Globalization.SortKey" /> object.
protected void
Finalize​()
Inherited from object
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
public Type
GetType​()
Inherited from object
Gets the <see cref="T:System.Type" /> of the current instance.
Returns The exact runtime type of the current instance.
protected object
MemberwiseClone​()
Inherited from object
Creates a shallow copy of the current <see cref="T:System.Object" /> .
Returns A shallow copy of the current <see cref="T:System.Object" /> .