{"componentChunkName":"component---src-pages-markdown-remark-fields-slug-js","path":"/engineering/enum-csharp/","result":{"data":{"markdownRemark":{"id":"0099d97a-fedc-5e4a-bad6-5a1c122dae72","excerpt":"Enum is a typed constant that is specified for the new data form of Enumeration. An effective way to describe a set of named integral constants assigned to a…","html":"

Enum is a typed constant that is specified for the new data form of Enumeration. An effective way to describe a set of named integral constants assigned to a variable is to include a Typesafe enumeration. Enums make the code more readable and less vulnerable to mistakes. If you have a set of functionally important and unchanged values, Enums are useful for developers.

\n

Enums' key benefit is to make it possible in the future to adjust values. Enums are a robust alternative to the short String or Int constants used to describe sets of similar objects in far older APIs.

\n

Sometimes we must use the constant variable in our application to not be changed throughout the application. One of the methods to declare the continuous variables are Enum. Let's discuss it.

\n

Using Enum in C Sharp

\n

Enum is the short form of Enumeration. Enum consumes less memory and space because they are value types, which means they store memory value. Also, Enums are strongly typed named constants.

\n

Enums written by developers are used in the .NET system to develop numeric constants. A numeric value must be allocated to all the members of an enum. Here are the main points about Enums:

\n\n

Enums are of two types in C#

\n

Simple Enum - The members of this enum contain a single value.

\n

Flags Enum - The members of this enum contain multiple values or multiple values combined using a bitwise OR operator. These enums are often used for bitwise operators.

\n

Here we will talk about the Simple Enum only.

\n

How to declare an Enum

\n

Enum is declared by the enum keyword followed by the enum name and then its enum members. Like an example below

\n
public enum Vehicle\n{\n    Car,\n    Bike=3,\n    Truck,\n    Taxi,\n}
\n

In the above code, an enum for the Vehicle is created. The enum values are started from 0 by default if we do not assign them the values and incremented by 1 for the next enum member.

\n

That means the Car enum has the value 0 and the Bike enum assigned the value 3 that means the Bike enum now has the value 3 and the next enums are incremented by 1 means Truck and Taxi enum have the value 4 and 5 respectively.

\n

By default, the type for enum elements is int. We can set different type by adding a colon like an example below.

\n
public enum Vehicle: byte\n{\n    Car,\n    Bike=3,\n    Truck,\n    Taxi,\n}
\n

The different types which can be set are sbyte, byte, short, ushort, uint, ulong, and long.

\n

Get the value of an Enum

\n

To get the value of enum we can simply typecast it to its type. In the first example, the default type is int so we have to typecast it to int. Also, we can get the string value of that enum by using the ToString() method as below.

\n
Console.WriteLine((int)VehicleEnum.Car);\nstring vehicle = Vehicle.Bike.ToString();\nConsole.WriteLine(vehicle);
\n

Output:

\n
0\nBike
\n

Parse the string value into an Enum

\n

For parsing the string value into enum we have 2 methods

\n
    \n
  1. Enum.Parse(Type enumType,string value) - This method directly parses the string representation of the name or numeric value of enum member into enumType object. If the string representation of the name is not found, then it will give the exception.
    2. \n
\n
Console.WriteLine(Enum.Parse(typeof(Vehicle),"Car"));
\n

Output:

\n
Car
\n
    \n
  1. Enum.TryParse(string? value,out enumType result) - This method gives the result in bool value. if the string representation of the name or numeric value of enum member into enumType object is parsed, then the result will be true, and the parsed value will be in the out variable. If the string value is not parsed, then the result will be false.
    2. \n
\n
Enum.TryParse("0",out Vehicle value);\nConsole.WriteLine(value);
\n

Output:

\n
Car
\n

Note - Both the methods also have overload methods.

\n

Check if a string value is defined in the Enum

\n

We can check if a given integral value, or its name as a string, exists in a specified enum.

\n
Console.WriteLine(Enum.IsDefined(typeof(Vehicle), 0));
\n

OR

\n
Console.WriteLine(Enum.IsDefined(typeof(Vehicle), "car"));
\n

Output:

\n
True
\n

Loop through all the Enum

\n

For looping through the enums you can write the below code -

\n
foreach (var data in Enum.GetNames(typeof(Vehicle)))\n{\n    Console.WriteLine(data+" - "+ (int)Enum.Parse(typeof(Vehicle), data));\n}
\n

Here Enum.GetNames(Type enumType) method is used, which retrieves an array of the names from the specified enum.

\n

Output:

\n
Car - 0\nBike - 3\nTruck - 4\nTaxi - 5
\n

Call an enum by the integral value

\n

We can call the enum member by its integral value. If there is no corresponding value related to that integral value, then it will print that integral value.

\n
 Console.WriteLine((Vehicle)3);
\n

Output

\n
Bike
\n

Conclusion

\n

The advantages of using enums are that they are very easy to use and represented as strings but processed as integers. Enums are easy to maintain and improve code readability because they provide symbolic named constants, which means you need to remember the names, not the integer values.

\n

If you want to learn more about C programming, here is another article written on C# Exceptions and Exception Handling in C# I hope you learn something new today and will going to try it out, if you have any questions feel free to drop a comment below.

\n","headings":[{"value":"Using Enum in C Sharp","depth":2},{"value":"How to declare an Enum","depth":2},{"value":"Get the value of an Enum","depth":2},{"value":"Parse the string value into an Enum","depth":2},{"value":"Check if a string value is defined in the Enum","depth":2},{"value":"Loop through all the Enum","depth":2},{"value":"Call an enum by the integral value","depth":2},{"value":"Conclusion","depth":2}],"fields":{"slug":"/engineering/enum-csharp/"},"frontmatter":{"metatitle":null,"metadescription":null,"description":"Would you like to become more proficient in your C# programming in the use of enums? To learn the basics and use cases for Enum in C#, read this post.","title":"How to Use Enum in C#","canonical":null,"date":"December 18, 2020","updated_date":null,"tags":["C#","Enum"],"coverImage":{"childImageSharp":{"fluid":{"aspectRatio":1.5037593984962405,"src":"/static/4730f4a49850d621c2969f5405e589e1/2ad7f/coverimage.webp","srcSet":"/static/4730f4a49850d621c2969f5405e589e1/1c9b5/coverimage.webp 200w,\n/static/4730f4a49850d621c2969f5405e589e1/f1752/coverimage.webp 400w,\n/static/4730f4a49850d621c2969f5405e589e1/2ad7f/coverimage.webp 800w,\n/static/4730f4a49850d621c2969f5405e589e1/b13b4/coverimage.webp 900w","sizes":"(max-width: 800px) 100vw, 800px"}}},"author":{"id":"Hemant Manwani","github":"hemant404","bio":"Hemant Manwani is a Software Engineer at LoginRadius who is interested in how the web works and developer tools that make working with web easier.","avatar":null}}}},"pageContext":{"id":"0099d97a-fedc-5e4a-bad6-5a1c122dae72","fields__slug":"/engineering/enum-csharp/","__params":{"fields__slug":"engineering"}}},"staticQueryHashes":["1171199041","1384082988","1711371485","1753898100","2100481360","229320306","23180105","528864852"]}