EnumBuilder Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Describes and represents an enumeration type.

Inheritance Hierarchy

System.Object
  System.Reflection.MemberInfo
    System.Type
      System.Reflection.Emit.EnumBuilder

Namespace:  System.Reflection.Emit
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
<ComVisibleAttribute(True)> _
<ClassInterfaceAttribute(ClassInterfaceType.None)> _
Public NotInheritable Class EnumBuilder _
    Inherits Type

[ComVisibleAttribute(true)]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
public sealed class EnumBuilder : Type

The EnumBuilder type exposes the following members.

Properties

	Name	Description
	Assembly	Retrieves the dynamic assembly that contains this enum definition. (Overrides Type.Assembly.)
	AssemblyQualifiedName	Returns the full path of this enum qualified by the display name of the parent assembly. (Overrides Type.AssemblyQualifiedName.)
	Attributes	Gets the attributes associated with the Type. (Inherited from Type.)
	BaseType	Returns the parent Type of this type which is always Enum. (Overrides Type.BaseType.)
	ContainsGenericParameters	Gets a value indicating whether the current Type object has type parameters that have not been replaced by specific types. (Inherited from Type.)
	DeclaringMethod	Gets a MethodBase that represents the declaring method, if the current Type represents a type parameter of a generic method. (Inherited from Type.)
	DeclaringType	Returns the type that declared this EnumBuilder. (Overrides Type.DeclaringType.)
	FullName	Returns the full path of this enumeration. (Overrides Type.FullName.)
	GenericParameterAttributes	Gets a combination of GenericParameterAttributes flags that describe the covariance and special constraints of the current generic type parameter. (Inherited from Type.)
	GenericParameterPosition	Gets the position of the type parameter in the type parameter list of the generic type or method that declared the parameter, when the Type object represents a type parameter of a generic type or a generic method. (Inherited from Type.)
	GUID	Returns the GUID of this enum. (Overrides Type.GUID.)
	HasElementType	Gets a value indicating whether the current Type encompasses or refers to another type; that is, whether the current Type is an array, a pointer, or is passed by reference. (Inherited from Type.)
	IsAbstract	Gets a value indicating whether the Type is abstract and must be overridden. (Inherited from Type.)
	IsAnsiClass	Gets a value indicating whether the string format attribute AnsiClass is selected for the Type. (Inherited from Type.)
	IsArray	Gets a value indicating whether the Type is an array. (Inherited from Type.)
	IsAutoClass	Gets a value indicating whether the string format attribute AutoClass is selected for the Type. (Inherited from Type.)
	IsAutoLayout	Gets a value indicating whether the class layout attribute AutoLayout is selected for the Type. (Inherited from Type.)
	IsByRef	Gets a value indicating whether the Type is passed by reference. (Inherited from Type.)
	IsClass	Gets a value indicating whether the Type is a class; that is, not a value type or interface. (Inherited from Type.)
	IsCOMObject	Gets a value indicating whether the Type is a COM object. (Inherited from Type.)
	IsEnum	Gets a value indicating whether the current Type represents an enumeration. (Inherited from Type.)
	IsGenericParameter	Gets a value indicating whether the current Type represents a type parameter in the definition of a generic type or method. (Inherited from Type.)
	IsGenericType	Gets a value indicating whether the current type is a generic type. (Inherited from Type.)
	IsGenericTypeDefinition	Gets a value indicating whether the current Type represents a generic type definition, from which other generic types can be constructed. (Inherited from Type.)
	IsImport	Gets a value indicating whether the Type has a ComImportAttribute attribute applied, indicating that it was imported from a COM type library. (Inherited from Type.)
	IsInterface	Gets a value indicating whether the Type is an interface; that is, not a class or a value type. (Inherited from Type.)
	IsNested	Gets a value indicating whether the current Type object represents a type whose definition is nested inside the definition of another type. (Inherited from Type.)
	IsNestedAssembly	Gets a value indicating whether the Type is nested and visible only within its own assembly. (Inherited from Type.)
	IsNestedFamANDAssem	Gets a value indicating whether the Type is nested and visible only to classes that belong to both its own family and its own assembly. (Inherited from Type.)
	IsNestedFamily	Gets a value indicating whether the Type is nested and visible only within its own family. (Inherited from Type.)
	IsNestedFamORAssem	Gets a value indicating whether the Type is nested and visible only to classes that belong to either its own family or to its own assembly. (Inherited from Type.)
	IsNestedPrivate	Gets a value indicating whether the Type is nested and declared private. (Inherited from Type.)
	IsNestedPublic	Gets a value indicating whether a class is nested and declared public. (Inherited from Type.)
	IsNotPublic	Gets a value indicating whether the Type is not declared public. (Inherited from Type.)
	IsPointer	Gets a value indicating whether the Type is a pointer. (Inherited from Type.)
	IsPrimitive	Gets a value indicating whether the Type is one of the primitive types. (Inherited from Type.)
	IsPublic	Gets a value indicating whether the Type is declared public. (Inherited from Type.)
	IsSealed	Gets a value indicating whether the Type is declared sealed. (Inherited from Type.)
	IsSpecialName	Gets a value indicating whether the Type has a name that requires special handling. (Inherited from Type.)
	IsUnicodeClass	Gets a value indicating whether the string format attribute UnicodeClass is selected for the Type. (Inherited from Type.)
	IsValueType	Gets a value indicating whether the Type is a value type. (Inherited from Type.)
	IsVisible	Gets a value indicating whether the Type can be accessed by code outside the assembly. (Inherited from Type.)
	MemberType	Gets a MemberTypes value indicating that this member is a type or a nested type. (Inherited from Type.)
	MetadataToken	Gets a value that identifies a metadata element. (Inherited from MemberInfo.)
	Module	Retrieves the dynamic module that contains this EnumBuilder definition. (Overrides Type.Module.)
	Name	Returns the name of this enum. (Overrides MemberInfo.Name.)
	Namespace	Returns the namespace of this enum. (Overrides Type.Namespace.)
	ReflectedType	Returns the type that was used to obtain this EnumBuilder. (Overrides Type.ReflectedType.)
	TypeHandle	Retrieves the internal handle for this enum. (Overrides Type.TypeHandle.)
	TypeToken	Gets the internal metadata type token of this enum.
	UnderlyingField	Gets the underlying field for this enum.
	UnderlyingSystemType	Gets the underlying system type for this enum. (Overrides Type.UnderlyingSystemType.)

Top

Methods

	Name	Description
	CreateType	Creates a Type object for this enum.
	DefineLiteral	Defines the named static field in an enumeration type with the specified constant value.
	Equals(Object)	Determines if the underlying system type of the current Type is the same as the underlying system type of the specified Object. (Inherited from Type.)
	Equals(Type)	Determines if the underlying system type of the current Type is the same as the underlying system type of the specified Type. (Inherited from Type.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	FindMembers	Returns a filtered array of MemberInfo objects of the specified member type. (Inherited from Type.)
	GetArrayRank	Gets the number of dimensions in an Array. (Inherited from Type.)
	GetAttributeFlagsImpl	When overridden in a derived class, implements the Attributes property and gets a bitmask indicating the attributes associated with the Type. (Inherited from Type.)
	GetConstructor(array<Type[])	Searches for a public instance constructor whose parameters match the types in the specified array. (Inherited from Type.)
	GetConstructor(BindingFlags, Binder, array<Type[], array<ParameterModifier[])	Searches for a constructor whose parameters match the specified argument types and modifiers, using the specified binding constraints. (Inherited from Type.)
	GetConstructorImpl	When overridden in a derived class, searches for a constructor whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention. (Inherited from Type.)
	GetConstructors()	Returns all the public constructors defined for the current Type. (Inherited from Type.)
	GetConstructors(BindingFlags)	Returns an array of ConstructorInfo objects representing the public and non-public constructors defined for this class, as specified. (Overrides Type.GetConstructors(BindingFlags).)
	GetCustomAttributes(Boolean)	Returns all the custom attributes defined for this constructor. (Overrides MemberInfo.GetCustomAttributes(Boolean).)
	GetCustomAttributes(Type, Boolean)	Returns the custom attributes identified by the given type. (Overrides MemberInfo.GetCustomAttributes(Type, Boolean).)
	GetDefaultMembers	Searches for the members defined for the current Type whose DefaultMemberAttribute is set. (Inherited from Type.)
	GetElementType	Calling this method always throws NotSupportedException. (Overrides Type.GetElementType().)
	GetEvent(String)	Returns the EventInfo object representing the specified public event. (Inherited from Type.)
	GetEvent(String, BindingFlags)	Returns the event with the specified name. (Overrides Type.GetEvent(String, BindingFlags).)
	GetEvents()	Returns the events for the public events declared or inherited by this type. (Overrides Type.GetEvents().)
	GetEvents(BindingFlags)	Returns the public and non-public events that are declared by this type. (Overrides Type.GetEvents(BindingFlags).)
	GetField(String)	Searches for the public field with the specified name. (Inherited from Type.)
	GetField(String, BindingFlags)	Returns the field specified by the given name. (Overrides Type.GetField(String, BindingFlags).)
	GetFields()	Returns all the public fields of the current Type. (Inherited from Type.)
	GetFields(BindingFlags)	Returns the public and non-public fields that are declared by this type. (Overrides Type.GetFields(BindingFlags).)
	GetGenericArguments	Returns an array of Type objects that represent the type arguments of a generic type or the type parameters of a generic type definition. (Inherited from Type.)
	GetGenericParameterConstraints	Returns an array of Type objects that represent the constraints on the current generic type parameter. (Inherited from Type.)
	GetGenericTypeDefinition	Returns a Type object that represents a generic type definition from which the current generic type can be constructed. (Inherited from Type.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Type.)
	GetInterface	Returns the interface implemented (directly or indirectly) by this type, with the specified fully-qualified name. (Overrides Type.GetInterface(String, Boolean).)
	GetInterfaceMap	Returns an interface mapping for the interface requested. (Overrides Type.GetInterfaceMap(Type).)
	GetInterfaces	Returns an array of all the interfaces implemented on this a class and its base classes. (Overrides Type.GetInterfaces().)
	GetMember(String)	Searches for the public members with the specified name. (Inherited from Type.)
	GetMember(String, BindingFlags)	Searches for the specified members, using the specified binding constraints. (Inherited from Type.)
	GetMember(String, MemberTypes, BindingFlags)	Returns all members with the specified name, type, and binding that are declared or inherited by this type. (Overrides Type.GetMember(String, MemberTypes, BindingFlags).)
	GetMembers()	Returns all the public members of the current Type. (Inherited from Type.)
	GetMembers(BindingFlags)	Returns the specified members declared or inherited by this type,. (Overrides Type.GetMembers(BindingFlags).)
	GetMethod(String)	Searches for the public method with the specified name. (Inherited from Type.)
	GetMethod(String, BindingFlags)	Searches for the specified method, using the specified binding constraints. (Inherited from Type.)
	GetMethod(String, array<Type[])	Searches for the specified public method whose parameters match the specified argument types. (Inherited from Type.)
	GetMethod(String, array<Type[], array<ParameterModifier[])	Searches for the specified public method whose parameters match the specified argument types and modifiers. (Inherited from Type.)
	GetMethod(String, BindingFlags, Binder, array<Type[], array<ParameterModifier[])	Searches for the specified method whose parameters match the specified argument types and modifiers, using the specified binding constraints. (Inherited from Type.)
	GetMethod(String, BindingFlags, Binder, CallingConventions, array<Type[], array<ParameterModifier[])	Searches for the specified method whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention. (Inherited from Type.)
	GetMethodImpl	When overridden in a derived class, searches for the specified method whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention. (Inherited from Type.)
	GetMethods()	Returns all the public methods of the current Type. (Inherited from Type.)
	GetMethods(BindingFlags)	Returns all the public and non-public methods declared or inherited by this type, as specified. (Overrides Type.GetMethods(BindingFlags).)
	GetNestedType	Returns the specified nested type that is declared by this type. (Overrides Type.GetNestedType(String, BindingFlags).)
	GetNestedTypes	Returns the public and non-public nested types that are declared or inherited by this type. (Overrides Type.GetNestedTypes(BindingFlags).)
	GetProperties()	Returns all the public properties of the current Type. (Inherited from Type.)
	GetProperties(BindingFlags)	Returns all the public and non-public properties declared or inherited by this type, as specified. (Overrides Type.GetProperties(BindingFlags).)
	GetProperty(String)	Searches for the public property with the specified name. (Inherited from Type.)
	GetProperty(String, BindingFlags)	Searches for the specified property, using the specified binding constraints. (Inherited from Type.)
	GetProperty(String, Type)	Searches for the public property with the specified name and return type. (Inherited from Type.)
	GetProperty(String, Type, array<Type[])	Searches for the specified public property whose parameters match the specified argument types. (Inherited from Type.)
	GetProperty(String, Type, array<Type[], array<ParameterModifier[])	Searches for the specified public property whose parameters match the specified argument types and modifiers. (Inherited from Type.)
	GetProperty(String, BindingFlags, Binder, Type, array<Type[], array<ParameterModifier[])	Searches for the specified property whose parameters match the specified argument types and modifiers, using the specified binding constraints. (Inherited from Type.)
	GetPropertyImpl	When overridden in a derived class, searches for the specified property whose parameters match the specified argument types and modifiers, using the specified binding constraints. (Inherited from Type.)
	GetType()	Gets the current Type. (Inherited from Type.)
	HasElementTypeImpl	When overridden in a derived class, implements the HasElementType property and determines whether the current Type encompasses or refers to another type; that is, whether the current Type is an array, a pointer, or is passed by reference. (Inherited from Type.)
	InvokeMember(String, BindingFlags, Binder, Object, array<Object[])	Invokes the specified member, using the specified binding constraints and matching the specified argument list. (Inherited from Type.)
	InvokeMember(String, BindingFlags, Binder, Object, array<Object[], array<ParameterModifier[], CultureInfo, array<String[])	Invokes the specified member. The method that is to be invoked must be accessible and provide the most specific match with the specified argument list, under the contraints of the specified binder and invocation attributes. (Overrides Type.InvokeMember(String, BindingFlags, Binder, Object, array<Object[], array<ParameterModifier[], CultureInfo, array<String[]).)
	IsArrayImpl	When overridden in a derived class, implements the IsArray property and determines whether the Type is an array. (Inherited from Type.)
	IsAssignableFrom	Determines whether an instance of the current Type can be assigned from an instance of the specified Type. (Inherited from Type.)
	IsByRefImpl	When overridden in a derived class, implements the IsByRef property and determines whether the Type is passed by reference. (Inherited from Type.)
	IsCOMObjectImpl	When overridden in a derived class, implements the IsCOMObject property and determines whether the Type is a COM object. (Inherited from Type.)
	IsDefined	Checks if the specified custom attribute type is defined. (Overrides MemberInfo.IsDefined(Type, Boolean).)
	IsInstanceOfType	Determines whether the specified object is an instance of the current Type. (Inherited from Type.)
	IsPointerImpl	When overridden in a derived class, implements the IsPointer property and determines whether the Type is a pointer. (Inherited from Type.)
	IsPrimitiveImpl	When overridden in a derived class, implements the IsPrimitive property and determines whether the Type is one of the primitive types. (Inherited from Type.)
	IsSubclassOf	Determines whether the class represented by the current Type derives from the class represented by the specified Type. (Inherited from Type.)
	IsValueTypeImpl	Implements the IsValueType property and determines whether the Type is a value type; that is, not a class or an interface. (Inherited from Type.)
	MakeArrayType()	Returns a Type object representing a one-dimensional array of the current type, with a lower bound of zero. (Overrides Type.MakeArrayType().)
	MakeArrayType(Int32)	Returns a Type object representing an array of the current type, with the specified number of dimensions. (Overrides Type.MakeArrayType(Int32).)
	MakeByRefType	Returns a Type object that represents the current type when passed as a ref parameter (ByRef parameter in Visual Basic). (Overrides Type.MakeByRefType().)
	MakeGenericType	Substitutes the elements of an array of types for the type parameters of the current generic type definition and returns a Type object representing the resulting constructed type. (Inherited from Type.)
	MakePointerType	Returns a Type object that represents a pointer to the current type. (Overrides Type.MakePointerType().)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetCustomAttribute	Sets a custom attribute using a custom attribute builder.
	ToString	Returns a String representing the name of the current Type. (Inherited from Type.)

Top

Remarks

To get an EnumBuilder, use the ModuleBuilder.DefineEnum method. To define a nested enumeration, use one of the overloads of the TypeBuilder.DefineNestedType method that specifies a base type. Specify Enum as the base type.

Examples

The following code example demonstrates the construction of an enumeration within a dynamic assembly, using EnumBuilder. The example defines an enumeration named Elevation, with an underlying type of Int32, and creates two elements: Low, with a value of 0, and High, with a value of 1.

Note:
To run this example, see Building Examples That Use a Demo Method and a TextBlock Control.

Imports System.Reflection
Imports System.Reflection.Emit

Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)

      ' Get the current application domain for the current thread.
      Dim currentDomain As AppDomain = AppDomain.CurrentDomain

      ' Create a dynamic assembly in the current application domain, 
      ' and allow it to be executed.
      Dim aName As AssemblyName = New AssemblyName("TempAssembly")
      Dim ab As AssemblyBuilder = currentDomain.DefineDynamicAssembly( _
          aName, AssemblyBuilderAccess.Run)

      ' Define a dynamic module in "TempAssembly" assembly. The module can
      ' have the same name as the assembly.
      Dim mb As ModuleBuilder = _
          ab.DefineDynamicModule(aName.Name)

      ' Define a public enumeration with the name "Elevation" and an 
      ' underlying type of Integer.
      Dim eb As EnumBuilder = _
          mb.DefineEnum("Elevation", TypeAttributes.Public, GetType(Integer))

      ' Define two members, "High" and "Low".
      eb.DefineLiteral("Low", 0)
      eb.DefineLiteral("High", 1)

      ' Create the type.
      Dim finished As Type = eb.CreateType()

      For Each fi As FieldInfo in finished.GetFields()
         outputBlock.Text += String.Format("{0}.{1} = {2}" & vbCrLf, _
            finished.Name, fi.Name, fi.GetRawConstantValue())
      Next
   End Sub
End Class

' This code example produces the following output:
'
'Elevation.Low = 0
'Elevation.High = 1 

using System;
using System.Reflection;
using System.Reflection.Emit;

class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      // Get the current application domain for the current thread.
      AppDomain currentDomain = AppDomain.CurrentDomain;

      // Create a dynamic assembly in the current application domain, 
      // and allow it to be executed.
      AssemblyName aName = new AssemblyName("TempAssembly");
      AssemblyBuilder ab = currentDomain.DefineDynamicAssembly(
          aName, AssemblyBuilderAccess.Run);

      // Define a dynamic module in "TempAssembly" assembly. The module can
      // have the same name as the assembly.
      ModuleBuilder mb = ab.DefineDynamicModule(aName.Name);

      // Define a public enumeration with the name "Elevation" and an 
      // underlying type of Integer.
      EnumBuilder eb = mb.DefineEnum("Elevation", TypeAttributes.Public, typeof(int));

      // Define two members, "High" and "Low".
      eb.DefineLiteral("Low", 0);
      eb.DefineLiteral("High", 1);

      // Create the type.
      Type finished = eb.CreateType();

      foreach (FieldInfo fi in finished.GetFields())
      {
         outputBlock.Text += String.Format("{0}.{1} = {2}\n", 
            finished.Name, fi.Name, fi.GetRawConstantValue());
      }
   }
}

/* This code example produces the following output:

Elevation.Low = 0
Elevation.High = 1 
 */

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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

See Also

Reference

System.Reflection.Emit Namespace