InvalidEnumArgumentException Class

 

The exception thrown when using invalid arguments that are enumerators.

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)

System.Object
  System.Exception
    System.SystemException
      System.ArgumentException
        System.ComponentModel.InvalidEnumArgumentException

[SerializableAttribute]
[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public class InvalidEnumArgumentException : ArgumentException

NameDescription
System_CAPS_pubmethodInvalidEnumArgumentException()

Initializes a new instance of the InvalidEnumArgumentException class without a message.

System_CAPS_protmethodInvalidEnumArgumentException(SerializationInfo, StreamingContext)

Initializes a new instance of the InvalidEnumArgumentException class using the specified serialization data and context.

System_CAPS_pubmethodInvalidEnumArgumentException(String)

Initializes a new instance of the InvalidEnumArgumentException class with the specified message.

System_CAPS_pubmethodInvalidEnumArgumentException(String, Exception)

Initializes a new instance of the InvalidEnumArgumentException class with the specified detailed description and the specified exception.

System_CAPS_pubmethodInvalidEnumArgumentException(String, Int32, Type)

Initializes a new instance of the InvalidEnumArgumentException class with a message generated from the argument, the invalid value, and an enumeration class.

NameDescription
System_CAPS_pubpropertyData

Gets a collection of key/value pairs that provide additional user-defined information about the exception.(Inherited from Exception.)

System_CAPS_pubpropertyHelpLink

Gets or sets a link to the help file associated with this exception.(Inherited from Exception.)

System_CAPS_pubpropertyHResult

Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.(Inherited from Exception.)

System_CAPS_pubpropertyInnerException

Gets the Exception instance that caused the current exception.(Inherited from Exception.)

System_CAPS_pubpropertyMessage

Gets the error message and the parameter name, or only the error message if no parameter name is set.(Inherited from ArgumentException.)

System_CAPS_pubpropertyParamName

Gets the name of the parameter that causes this exception.(Inherited from ArgumentException.)

System_CAPS_pubpropertySource

Gets or sets the name of the application or the object that causes the error.(Inherited from Exception.)

System_CAPS_pubpropertyStackTrace

Gets a string representation of the immediate frames on the call stack.(Inherited from Exception.)

System_CAPS_pubpropertyTargetSite

Gets the method that throws the current exception.(Inherited from Exception.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetBaseException()

When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.(Inherited from Exception.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetObjectData(SerializationInfo, StreamingContext)

Sets the SerializationInfo object with the parameter name and additional exception information.(Inherited from ArgumentException.)

System_CAPS_pubmethodGetType()

Gets the runtime type of the current instance.(Inherited from Exception.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Creates and returns a string representation of the current exception.(Inherited from Exception.)

NameDescription
System_CAPS_proteventSerializeObjectState

Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.(Inherited from Exception.)

This exception is thrown if you pass an invalid enumeration value to a method or when setting a property.

The following code example shows how to catch an InvalidEnumArgumentException exception and interpret its content. The example attempts to pass an invalid enumeration value (MessageBoxButtons) through casting, as the MessageBox.Show method's third argument. Upon catching the exception, the example fetches the respective error message, the invalid parameter, stack trace, and origin of the exception.

try 
{
// Attempts to pass an invalid enum value (MessageBoxButtons) to the Show method
    MessageBoxButtons myButton= (MessageBoxButtons) 123;
    MessageBox.Show("This is a message","This is the Caption",myButton);
}
catch(InvalidEnumArgumentException invE) 
{
    Console.WriteLine(invE.Message);
    Console.WriteLine(invE.ParamName);
    Console.WriteLine(invE.StackTrace);
    Console.WriteLine(invE.Source);
}

.NET Framework
Available since 1.1
Silverlight
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: