Collation ClassCollation ClassCollation Class

Represents a collation for use in XQuery and XPath functions.

Inheritance Hierarchy

Syntax

Public MustInherit Class Collation
public abstract class Collation
public:
ref class Collation abstract
 
The CollationCollationCollation type exposes the following members.

Constructors

 ConstructorDescription
Protected methodCollationCollationCollation Initializes a new instance of the CollationCollationCollation class.

Top

Properties

 PropertyDescription
Public propertystaticCodepointCollationCodepointCollationCodepointCollation Gets the codepoint collation.

Top

Methods

 MethodDescription
Public methodAreEqualAreEqualAreEqual Compares two specified stringStringString values for equality under this collation.
Public methodCompareCompareCompare Compares two specified stringStringString objects under this collation.
Public methodstaticCultureCollation (CultureInfo)CultureCollation (CultureInfo)CultureCollation (CultureInfo^) Creates a new CollationCollationCollation instance which uses a CultureInfoCultureInfoCultureInfo to perform string comparisons.
Public methodstaticCultureCollation (CultureInfo, XmlCaseOrder)CultureCollation (CultureInfo, XmlCaseOrder)CultureCollation (CultureInfo^, XmlCaseOrder) Creates a new CollationCollationCollation instance which uses a CultureInfoCultureInfoCultureInfo and XmlCaseOrderXmlCaseOrderXmlCaseOrder to perform string comparisons.
Public methodEndsWithEndsWithEndsWith Returns a boolean value indicating whether one string ends with a specified suffix under this collation.
Public methodObject.EqualsObject.EqualsObject::Equals Determines whether the specified objectObjectobject is equal to the current objectObjectobject. (Inherited from System.ObjectSystem.ObjectSystem::Object)
Protected methodObject.FinalizeObject.FinalizeObject::Finalize Allows an objectObjectobject to attempt to free resources and perform other cleanup operations before the objectObjectobject is reclaimed by garbage collection. (Inherited from System.ObjectSystem.ObjectSystem::Object)
Public methodObject.GetHashCodeObject.GetHashCodeObject::GetHashCode Serves as a hash function for a particular type. (Inherited from System.ObjectSystem.ObjectSystem::Object)
Public methodGetSortKeyGetSortKeyGetSortKey Gets the sort key for the specified stringStringString as a byte array under this collation.
Public methodObject.GetTypeObject.GetTypeObject::GetType Gets the TypeTypeType of the current instance. (Inherited from System.ObjectSystem.ObjectSystem::Object)
Public methodIndexOfIndexOfIndexOf Returns the index of the first occurrence of a stringStringString within another stringStringString under this collation.
Public methodIsEmptyIsEmptyIsEmpty Returns a boolean value indicating whether a stringStringString is equal to the empty string under this collation.
Protected methodObject.MemberwiseCloneObject.MemberwiseCloneObject::MemberwiseClone Creates a shallow copy of the current objectObjectobject. (Inherited from System.ObjectSystem.ObjectSystem::Object)
Public methodStartsWithStartsWithStartsWith Returns a boolean value indicating whether one string starts with a specified prefix under this collation.
Public methodSubstringAfterSubstringAfterSubstringAfter Returns the substring of a stringStringString that follows the first occurrence of the specified substring under this collation.
Public methodSubstringBeforeSubstringBeforeSubstringBefore Returns the substring of a stringStringString that precedes the first occurrence of the the specified substring.
Public methodObject.ToStringObject.ToStringObject::ToString Returns a stringStringString that represents the current objectObjectobject. (Inherited from System.ObjectSystem.ObjectSystem::Object)

Top

Remarks

A collation is used to determine the sorting order of strings of characters.

Built in implementations of CollationCollationCollation are accessible through the CultureCollation (CultureInfo, XmlCaseOrder)CultureCollation (CultureInfo, XmlCaseOrder)CultureCollation (CultureInfo^, XmlCaseOrder) method and the CodepointCollationCodepointCollationCodepointCollation property.