C# | Boolean.CompareTo(Object) Method

Boolean.CompareTo(Object) Method is used to compare the current instance to a specified object and returns an integer which shows their relationship to one another.

Syntax:

public int CompareTo (object obj);

Here, it takes an object to compare to current instance or null.

Return Value: This method returns a signed integer which shows the relative order of the current instance and obj.

• Less than zero: If this instance is false and obj is true.
• Zero: If this instance and obj are equal (either both are true or both are false).
• Greater than zero: If this instance is true and obj is false or null.

Exception: It throws ArgumentException if obj is not an Boolean.

Example 1:

// C# program to demonstrate the
// Boolean.CompareTo(Object) Method
using System;

class GFG {

    // Main Method
    public static void Main()
    {
        try {

            // Declaring and initializing value1
            bool value1 = true;

            // Declaring and initializing value2
            object value2 = true;

            // using CompareTo() method
            int status = value1.CompareTo(value2);

            // checking the status
            if (status > 0)
                Console.WriteLine("{0} is greater than {1}",
                                            value1, value2);

            else if (status < 0)
                Console.WriteLine("{0} is less than {1}",
                                         value1, value2);
            else
                Console.WriteLine("{0} is equal to {1}",
                                        value1, value2);
        }

        catch (ArgumentException e)
        {
            Console.WriteLine("value2 must be Boolean");
            Console.Write("Exception Thrown: ");
            Console.Write("{0}", e.GetType(), e.Message);
        }
    }
}

Output:

True is equal to True

Example 2: For ArgumentException

// C# program to demonstrate the
// Boolean.CompareTo(Object) Method
using System;
using System.Globalization;

class GFG {

    // Main Method
    public static void Main()
    {
        try {

            // Declaring and initializing value1
            bool value1 = true;

            // Declaring and initializing value2
            object value2 = 53554;

            // using CompareTo() method
            int status = value1.CompareTo(value2);

            // checking the status
            if (status > 0)
                Console.WriteLine("{0} is greater than {1}",
                                            value1, value2);

            else if (status < 0)
                Console.WriteLine("{0} is less than {1}",
                                         value1, value2);
            else
                Console.WriteLine("{0} is equal to {1}",
                                        value1, value2);
        }

        catch (ArgumentException e)
        {
            Console.WriteLine("value2 must be Boolean");
            Console.Write("Exception Thrown: ");
            Console.Write("{0}", e.GetType(), e.Message);
        }
    }
}

Output:

value2 must be Boolean
Exception Thrown: System.ArgumentException

Reference:

• https://docs.microsoft.com/en-us/dotnet/api/system.boolean.compareto?view=netframework-4.8#System_Boolean_CompareTo_System_Object_