SuggestionBase.CompareTo(Object) Method

Compares the SuggestionBase.Distance value of the SuggestionBase instance to the Levenshtein distance value of an object and returns an indication of their relative values.

Namespace: DevExpress.XtraSpellChecker

Assembly: DevExpress.SpellChecker.v24.1.Core.dll

NuGet Package: DevExpress.SpellChecker.Core

Declaration

C#

public int CompareTo(
    object obj
)

VB.NET

Public Function CompareTo(
    obj As Object
) As Integer

Parameters

Name	Type	Description
obj	Object	An object to compare.

Returns

Type	Description
Int32	A number indicating the relative values of this instance and value. If it is less than zero, this instance is less then the value; if zero - this instance is equal to the value; if greater than zero, this instance is greater than the value.

Remarks

If an object to compare is not a SuggestionBase instance, the method returns MinValue.