4.3. Testing for a Valid Enumeration Value
Problem
When a numeric value is passed to a method that accepts an enumeration type, it is possible that the numeric value does not exist in the parameter that accepts the enumeration value. You want to perform a test before using this numeric value to determine whether it is indeed listed in this enumeration type.
Solution
Use
the static Enum.IsDefined method on the
Enum class.
Using the following Language
enumeration:
enum Language
{
Other = 0, CSharp = 1, VBNET = 2, VB6 = 3
}If we have a method that accepts the Language
enumeration such as the following
method:
public void HandleEnum(Language language)
{
// Use language here...
}Discussion
The static Enum.IsDefined method determines
whether an enumeration value actually exists within an enumeration of
a particular type. Enum.IsDefined is a check used
to determine whether the values exist in the enumeration before they
are used in your code. This method returns a bool
value, where a true indicates that the enumeration
value is defined in this enumeration and false
indicates that it is not.
The Enum.IsDefined method
should be used to determine whether a valid enumeration value has
been passed to any method that accepts an enumeration value as a
parameter. In particular, this Enum.IsDefined should always be used whenever the method is visible to external objects. Any external object can invoke methods with public visibility; therefore, any enumerated value passed in to this method should be ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access