InvalidEnumArgumentException Class

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.Primitives.dll

Source:

InvalidEnumArgumentException.cs

The exception that is thrown when an invalid enumeration value is used.

public ref class InvalidEnumArgumentException : ArgumentException

public class InvalidEnumArgumentException : ArgumentException

type InvalidEnumArgumentException = class
    inherit ArgumentException

Public Class InvalidEnumArgumentException
Inherits ArgumentException

Inheritance

Object

Exception

SystemException

ArgumentException

InvalidEnumArgumentException

Examples

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
{
   //Attempting to pass an invalid enum value (MessageBoxButtons) to the Show method
   MessageBoxButtons myButton = (MessageBoxButtons)123; // to fix use System::Windows::Forms::DialogResult::OK;

   MessageBox::Show( this,  "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 );
}

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);
}

Try
    ' Attempts to pass an invalid enum value (MessageBoxButtons) to the Show method
    Dim myButton As MessageBoxButtons
    myButton = CType(123, MessageBoxButtons)
    MessageBox.Show("This is a message", "This is the Caption", myButton)
Catch invE As System.ComponentModel.InvalidEnumArgumentException
    Console.WriteLine(invE.Message)
    Console.WriteLine(invE.ParamName)
    Console.WriteLine(invE.StackTrace)
    Console.WriteLine(invE.Source)
End Try

Remarks

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

Constructors

InvalidEnumArgumentException()	Initializes a new instance of the InvalidEnumArgumentException class without a message.
InvalidEnumArgumentException(SerializationInfo, StreamingContext)	Obsolete. Initializes a new instance of the InvalidEnumArgumentException class using the specified serialization data and context.
InvalidEnumArgumentException(String, Exception)	Initializes a new instance of the InvalidEnumArgumentException class with the specified detailed description and the specified exception.
InvalidEnumArgumentException(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.
InvalidEnumArgumentException(String)	Initializes a new instance of the InvalidEnumArgumentException class with the specified message.

Properties

Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception)
HelpLink	Gets or sets a link to the help file associated with this exception. (Inherited from Exception)
HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception)
InnerException	Gets the Exception instance that caused the current exception. (Inherited from Exception)
Message	Gets the error message and the parameter name, or only the error message if no parameter name is set. (Inherited from ArgumentException)
ParamName	Gets the name of the parameter that causes this exception. (Inherited from ArgumentException)
Source	Gets or sets the name of the application or the object that causes the error. (Inherited from Exception)
StackTrace	Gets a string representation of the immediate frames on the call stack. (Inherited from Exception)
TargetSite	Gets the method that throws the current exception. (Inherited from Exception)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetBaseException()	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext)	Obsolete. Sets the SerializationInfo object with the parameter name and additional exception information. (Inherited from ArgumentException)
GetType()	Gets the runtime type of the current instance. (Inherited from Exception)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Creates and returns a string representation of the current exception. (Inherited from Exception)

Events

SerializeObjectState

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