Home » .Net » C# Programs

C# - Enum.CompareTo() Method with Example

In this tutorial, we will learn about the C# Enum.CompareTo() method with its definition, usage, syntax, and example. By Nidhi Last updated : March 29, 2023

C# Enum.CompareTo() Method

The Enum.CompareTo() method is used to compare instances with specific enum objects.

Syntax

int Enum.CompareTo(Enum obj);

Parameter(s)

• obj : It is an object that will compare with the current instance of an enum.

Return Value

This method returns an integer value that specifies the comparison of two enum objects.

• 0 : Both are equal
• >0 : Current object is greater than the specified object.
• <0 : Current object is less than the specified object.

Exception(s)

• System.ArgumentException
• System.InvalidOperationException
• System.NullReferenceException

C# Example of Enum.CompareTo() Method

The source code to demonstrate the use of CompareTo() method of Enum class is given below. The given program is compiled and executed successfully.

using System;

class Sample {
  enum Color {
    RED = 0, GREEN = 1, YELLOW = 3, WHITE = 4, BLACK = 5
  };

  //Entry point of Program
  static public void Main() {
    Color firstColor = Color.RED;
    Color secondColor = Color.WHITE;
    Color thirdColor = Color.BLACK;

    if (firstColor.CompareTo(secondColor) > 0)
      Console.WriteLine("FirstColor is greater than SecondColor");
    else
      Console.WriteLine("SecondColor is greater than FirstColor");

    if (secondColor.CompareTo(thirdColor) > 0)
      Console.WriteLine("SecondColor is greater than ThirdColor");
    else
      Console.WriteLine("ThirdColor is greater than SecondColor");
  }
}

Output

SecondColor is greater than FirstColor
ThirdColor is greater than SecondColor
Press any key to continue . . .

C# Enum Class Programs »