ValidateEnumValueAttribute Class

public class ValidateEnumValueAttribute : ArgumentValidationWithHelpAttribute

Public Class ValidateEnumValueAttribute
	Inherits ArgumentValidationWithHelpAttribute

Dim instance As ValidateEnumValueAttribute

public ref class ValidateEnumValueAttribute : public ArgumentValidationWithHelpAttribute

Inheritance

Object    Attribute    ArgumentValidationAttribute    ArgumentValidationWithHelpAttribute    ValidateEnumValueAttribute

The EnumConverter used to convert values for arguments with enumeration types allows conversion using the string representation of the underlying value, as well as the name. While names are checked against the members, any underlying value can be converted to an enumeration, regardless of whether it's a defined value for the enumeration.

For example, using the DayOfWeek enumeration, converting a string value of "9" would result in a value of (DayOfWeek)9, even though there is no enumeration member with that value.

This validator makes sure that the result of conversion is a valid value for the enumeration, by using the EnumIsDefined(Type, Object) method.

This validator can also alter the behavior of the EnumConverter class, through the CaseSensitive, AllowNumericValues, and AllowCommaSeparatedValues properties. These properties are only effective if the default EnumConverter class is used, or a custom converter that also checks them.

In addition, this validator provides usage help listing all the possible values. If the enumeration has a lot of values, you may wish to turn this off by setting the ArgumentValidationWithHelpAttributeIncludeInUsageHelp property to . Similarly, you can avoid listing all the values in the error message by setting the IncludeValuesInErrorMessage property to .

It is an error to use this validator on an argument whose type is not an enumeration.

Reference