String.IComparable.CompareTo(Object) 方法

定义

命名空间:
System
程序集:
mscorlib.dll, System.Runtime.dll
程序集:
System.Runtime.dll

将此实例与指定的 Object 实例进行比较，并指示此实例在排序顺序中是否与指定的 Object排序顺序位于同一位置。

 virtual int System.IComparable.CompareTo(System::Object ^ value) = IComparable::CompareTo;
int IComparable.CompareTo(object value);
abstract member System.IComparable.CompareTo : obj -> int
override this.System.IComparable.CompareTo : obj -> int
Function CompareTo (value As Object) As Integer Implements IComparable.CompareTo

参数

value
Object

一个计算结果为 . String. 的对象。

返回

Int32

一个 32 位带符号整数，指示此实例在排序顺序 value 中是否与参数位于同一位置、后跟或显示。

价值条件
小于零此实例位于 value.
零此实例在排序顺序中的位置与 value.
大于零此实例遵循 value或 value 为 null。

实现

CompareTo(Object)

例外

ArgumentException

value不是 .String

示例

以下示例将 CompareTo 该方法与 . Object. 由于该方法尝试将实例与对象进行比较String，因此该方法将引发一个 TestClass。ArgumentException

using System;

public class TestClass
{}

public class Example
{
   public static void Main()
   {
      var test = new TestClass();
      Object[] objectsToCompare = { test, test.ToString(), 123,
                                    123.ToString(), "some text",
                                    "Some Text" };
      string s = "some text";
      foreach (var objectToCompare in objectsToCompare) {
         try {
            int i = s.CompareTo(objectToCompare);
            Console.WriteLine("Comparing '{0}' with '{1}': {2}",
                              s, objectToCompare, i);
         }
         catch (ArgumentException) {
            Console.WriteLine("Bad argument: {0} (type {1})",
                              objectToCompare,
                              objectToCompare.GetType().Name);
         }
      }
   }
}
// The example displays the following output:
//    Bad argument: TestClass (type TestClass)
//    Comparing 'some text' with 'TestClass': -1
//    Bad argument: 123 (type Int32)
//    Comparing 'some text' with '123': 1
//    Comparing 'some text' with 'some text': 0
//    Comparing 'some text' with 'Some Text': -1

open System

type TestClass() = class end

let test = TestClass()
let objectsToCompare: obj list =
    [ test; string test; 123
      string 123; "some text"
      "Some Text" ]
let s = "some text"
for objectToCompare in objectsToCompare do
    try
        let i = s.CompareTo objectToCompare
        printfn $"Comparing '{s}' with '{objectToCompare}': {i}"
    with :? ArgumentException ->
        printfn $"Bad argument: {objectToCompare} (type {objectToCompare.GetType().Name})"
// The example displays the following output:
//    Bad argument: TestClass (type TestClass)
//    Comparing 'some text' with 'TestClass': -1
//    Bad argument: 123 (type Int32)
//    Comparing 'some text' with '123': 1
//    Comparing 'some text' with 'some text': 0
//    Comparing 'some text' with 'Some Text': -1

Public Class TestClass
End Class 


Public Class Example
   Public Shared Sub Main()
      Dim test As New TestClass()
      Dim objectsToCompare() As Object = { test, test.ToString(), 123,
                                           123.ToString(), "some text",
                                           "Some Text" }
      Dim s As String = "some text"
      For Each objectToCompare In objectsToCompare
         Try
            Dim i As Integer = s.CompareTo(objectToCompare)
            Console.WriteLine("Comparing '{0}' with '{1}': {2}",
                              s, objectToCompare, i)
         Catch e As ArgumentException
            Console.WriteLine("Bad argument: {0} (type {1})",
                              objectToCompare,
                              objectToCompare.GetType().Name)
         End Try
      Next
   End Sub 
End Class 
' The example displays the following output:
'       Bad argument: TestClass (type TestClass)
'       Comparing 'some text' with 'TestClass': -1
'       Bad argument: 123 (type Int32)
'       Comparing 'some text' with '123': 1
'       Comparing 'some text' with 'some text': 0
'       Comparing 'some text' with 'Some Text': -1

注解

value 必须是对象 String 。

Caution

该方法 CompareTo 主要用于排序或按字母顺序排列操作。 当方法调用的主要用途是确定两个字符串是否等效时，不应使用它。 若要确定两个字符串是否等效，请调用该方法 Equals 。

此方法使用当前区域性执行单词（区分大小写和区分区域性）比较。 有关单词、字符串和序号排序的详细信息，请参阅 System.Globalization.CompareOptions。

有关此方法行为的详细信息，请参阅该方法的 String.Compare(String, String) “备注”部分。

适用于