Export (0) Print
Expand All
1 out of 1 rated this helpful - Rate this topic

InvalidEnumArgumentException Class

The exception thrown when using invalid arguments that are enumerators.

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

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)
[SerializableAttribute]
[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public class InvalidEnumArgumentException : ArgumentException

The InvalidEnumArgumentException type exposes the following members.

  NameDescription
Public methodInvalidEnumArgumentException()Initializes a new instance of the InvalidEnumArgumentException class without a message.
Public methodInvalidEnumArgumentException(String)Initializes a new instance of the InvalidEnumArgumentException class with the specified message.
Protected methodInvalidEnumArgumentException(SerializationInfo, StreamingContext)Initializes a new instance of the InvalidEnumArgumentException class using the specified serialization data and context.
Public methodInvalidEnumArgumentException(String, Exception)Initializes a new instance of the InvalidEnumArgumentException class with the specified detailed description and the specified exception.
Public methodInvalidEnumArgumentException(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.
Top
  NameDescription
Public propertyDataGets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public propertyHelpLinkGets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Public propertyHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public propertyInnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public propertyMessageGets the error message and the parameter name, or only the error message if no parameter name is set. (Inherited from ArgumentException.)
Public propertyParamNameGets the name of the parameter that causes this exception. (Inherited from ArgumentException.)
Public propertySourceGets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public propertyStackTraceGets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public propertyTargetSiteGets the method that throws the current exception. (Inherited from Exception.)
Top
  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetObjectDataSets the SerializationInfo object with the parameter name and additional exception information. (Inherited from ArgumentException.)
Public methodGetTypeGets the runtime type of the current instance. (Inherited from Exception.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringCreates and returns a string representation of the current exception. (Inherited from Exception.)
Top
  NameDescription
Protected eventSerializeObjectStateOccurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)
Top

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

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

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

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.