Export (0) Print
Expand All

EnumBuilder Class

Describes and represents an enumeration type.

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

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

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

The EnumBuilder type exposes the following members.

  NameDescription
Public propertyAssemblyRetrieves the dynamic assembly that contains this enum definition. (Overrides Type.Assembly.)
Public propertyAssemblyQualifiedNameReturns the full path of this enum qualified by the display name of the parent assembly. (Overrides Type.AssemblyQualifiedName.)
Public propertyAttributesGets the attributes associated with the Type. (Inherited from Type.)
Public propertyBaseTypeReturns the parent Type of this type which is always Enum. (Overrides Type.BaseType.)
Public propertyContainsGenericParametersGets a value indicating whether the current Type object has type parameters that have not been replaced by specific types. (Inherited from Type.)
Public propertyDeclaringMethodGets a MethodBase that represents the declaring method, if the current Type represents a type parameter of a generic method. (Inherited from Type.)
Public propertyDeclaringTypeReturns the type that declared this EnumBuilder. (Overrides Type.DeclaringType.)
Public propertyFullNameReturns the full path of this enumeration. (Overrides Type.FullName.)
Public propertyGenericParameterAttributesGets a combination of GenericParameterAttributes flags that describe the covariance and special constraints of the current generic type parameter. (Inherited from Type.)
Public propertyGenericParameterPositionGets 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.)
Public propertyGUIDReturns the GUID of this enum. (Overrides Type.GUID.)
Public propertyHasElementTypeGets 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.)
Public propertyIsAbstractGets a value indicating whether the Type is abstract and must be overridden. (Inherited from Type.)
Public propertyIsAnsiClassGets a value indicating whether the string format attribute AnsiClass is selected for the Type. (Inherited from Type.)
Public propertyIsArrayGets a value indicating whether the Type is an array. (Inherited from Type.)
Public propertyIsAutoClassGets a value indicating whether the string format attribute AutoClass is selected for the Type. (Inherited from Type.)
Public propertyIsAutoLayoutGets a value indicating whether the class layout attribute AutoLayout is selected for the Type. (Inherited from Type.)
Public propertyIsByRefGets a value indicating whether the Type is passed by reference. (Inherited from Type.)
Public propertyIsClassGets a value indicating whether the Type is a class; that is, not a value type or interface. (Inherited from Type.)
Public propertyIsCOMObjectGets a value indicating whether the Type is a COM object. (Inherited from Type.)
Public propertyIsEnumGets a value indicating whether the current Type represents an enumeration. (Inherited from Type.)
Public propertyIsGenericParameterGets a value indicating whether the current Type represents a type parameter in the definition of a generic type or method. (Inherited from Type.)
Public propertyIsGenericTypeGets a value indicating whether the current type is a generic type. (Inherited from Type.)
Public propertyIsGenericTypeDefinitionGets a value indicating whether the current Type represents a generic type definition, from which other generic types can be constructed. (Inherited from Type.)
Public propertyIsImportGets a value indicating whether the Type has a ComImportAttribute attribute applied, indicating that it was imported from a COM type library. (Inherited from Type.)
Public propertyIsInterfaceGets a value indicating whether the Type is an interface; that is, not a class or a value type. (Inherited from Type.)
Public propertyIsNestedGets a value indicating whether the current Type object represents a type whose definition is nested inside the definition of another type. (Inherited from Type.)
Public propertyIsNestedAssemblyGets a value indicating whether the Type is nested and visible only within its own assembly. (Inherited from Type.)
Public propertyIsNestedFamANDAssemGets 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.)
Public propertyIsNestedFamilyGets a value indicating whether the Type is nested and visible only within its own family. (Inherited from Type.)
Public propertyIsNestedFamORAssemGets 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.)
Public propertyIsNestedPrivateGets a value indicating whether the Type is nested and declared private. (Inherited from Type.)
Public propertyIsNestedPublicGets a value indicating whether a class is nested and declared public. (Inherited from Type.)
Public propertyIsNotPublicGets a value indicating whether the Type is not declared public. (Inherited from Type.)
Public propertyIsPointerGets a value indicating whether the Type is a pointer. (Inherited from Type.)
Public propertyIsPrimitiveGets a value indicating whether the Type is one of the primitive types. (Inherited from Type.)
Public propertyIsPublicGets a value indicating whether the Type is declared public. (Inherited from Type.)
Public propertyIsSealedGets a value indicating whether the Type is declared sealed. (Inherited from Type.)
Public propertyIsSpecialNameGets a value indicating whether the Type has a name that requires special handling. (Inherited from Type.)
Public propertyIsUnicodeClassGets a value indicating whether the string format attribute UnicodeClass is selected for the Type. (Inherited from Type.)
Public propertyIsValueTypeGets a value indicating whether the Type is a value type. (Inherited from Type.)
Public propertyIsVisibleGets a value indicating whether the Type can be accessed by code outside the assembly. (Inherited from Type.)
Public propertyMemberTypeGets a MemberTypes value indicating that this member is a type or a nested type. (Inherited from Type.)
Public propertyMetadataTokenGets a value that identifies a metadata element. (Inherited from MemberInfo.)
Public propertyModuleRetrieves the dynamic module that contains this EnumBuilder definition. (Overrides Type.Module.)
Public propertyNameReturns the name of this enum. (Overrides MemberInfo.Name.)
Public propertyNamespaceReturns the namespace of this enum. (Overrides Type.Namespace.)
Public propertyReflectedTypeReturns the type that was used to obtain this EnumBuilder. (Overrides Type.ReflectedType.)
Public propertyTypeHandleRetrieves the internal handle for this enum. (Overrides Type.TypeHandle.)
Public propertyTypeTokenGets the internal metadata type token of this enum.
Public propertyUnderlyingFieldGets the underlying field for this enum.
Public propertyUnderlyingSystemTypeGets the underlying system type for this enum. (Overrides Type.UnderlyingSystemType.)
Top

  NameDescription
Public methodCreateTypeCreates a Type object for this enum.
Public methodDefineLiteralDefines the named static field in an enumeration type with the specified constant value.
Public methodEquals(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.)
Public methodEquals(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.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindMembersReturns a filtered array of MemberInfo objects of the specified member type. (Inherited from Type.)
Public methodGetArrayRankGets the number of dimensions in an Array. (Inherited from Type.)
Protected methodGetAttributeFlagsImplWhen overridden in a derived class, implements the Attributes property and gets a bitmask indicating the attributes associated with the Type. (Inherited from Type.)
Public methodGetConstructor(Type[])Searches for a public instance constructor whose parameters match the types in the specified array. (Inherited from Type.)
Public methodGetConstructor(BindingFlags, Binder, Type[], ParameterModifier[])Searches for a constructor whose parameters match the specified argument types and modifiers, using the specified binding constraints. (Inherited from Type.)
Protected methodGetConstructorImplWhen 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.)
Public methodGetConstructors()Returns all the public constructors defined for the current Type. (Inherited from Type.)
Public methodGetConstructors(BindingFlags)Returns an array of ConstructorInfo objects representing the public and non-public constructors defined for this class, as specified. (Overrides Type.GetConstructors(BindingFlags).)
Public methodGetCustomAttributes(Boolean)Returns all the custom attributes defined for this constructor. (Overrides MemberInfo.GetCustomAttributes(Boolean).)
Public methodGetCustomAttributes(Type, Boolean)Returns the custom attributes identified by the given type. (Overrides MemberInfo.GetCustomAttributes(Type, Boolean).)
Public methodGetDefaultMembersSearches for the members defined for the current Type whose DefaultMemberAttribute is set. (Inherited from Type.)
Public methodGetElementTypeCalling this method always throws NotSupportedException. (Overrides Type.GetElementType().)
Public methodGetEvent(String)Returns the EventInfo object representing the specified public event. (Inherited from Type.)
Public methodGetEvent(String, BindingFlags)Returns the event with the specified name. (Overrides Type.GetEvent(String, BindingFlags).)
Public methodGetEvents()Returns the events for the public events declared or inherited by this type. (Overrides Type.GetEvents().)
Public methodGetEvents(BindingFlags)Returns the public and non-public events that are declared by this type. (Overrides Type.GetEvents(BindingFlags).)
Public methodGetField(String)Searches for the public field with the specified name. (Inherited from Type.)
Public methodGetField(String, BindingFlags)Returns the field specified by the given name. (Overrides Type.GetField(String, BindingFlags).)
Public methodGetFields()Returns all the public fields of the current Type. (Inherited from Type.)
Public methodGetFields(BindingFlags)Returns the public and non-public fields that are declared by this type. (Overrides Type.GetFields(BindingFlags).)
Public methodGetGenericArgumentsReturns 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.)
Public methodGetGenericParameterConstraintsReturns an array of Type objects that represent the constraints on the current generic type parameter. (Inherited from Type.)
Public methodGetGenericTypeDefinitionReturns a Type object that represents a generic type definition from which the current generic type can be constructed. (Inherited from Type.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Type.)
Public methodGetInterfaceReturns the interface implemented (directly or indirectly) by this type, with the specified fully-qualified name. (Overrides Type.GetInterface(String, Boolean).)
Public methodGetInterfaceMapReturns an interface mapping for the interface requested. (Overrides Type.GetInterfaceMap(Type).)
Public methodGetInterfacesReturns an array of all the interfaces implemented on this a class and its base classes. (Overrides Type.GetInterfaces().)
Public methodGetMember(String)Searches for the public members with the specified name. (Inherited from Type.)
Public methodGetMember(String, BindingFlags)Searches for the specified members, using the specified binding constraints. (Inherited from Type.)
Public methodGetMember(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).)
Public methodGetMembers()Returns all the public members of the current Type. (Inherited from Type.)
Public methodGetMembers(BindingFlags)Returns the specified members declared or inherited by this type,. (Overrides Type.GetMembers(BindingFlags).)
Public methodGetMethod(String)Searches for the public method with the specified name. (Inherited from Type.)
Public methodGetMethod(String, BindingFlags)Searches for the specified method, using the specified binding constraints. (Inherited from Type.)
Public methodGetMethod(String, Type[])Searches for the specified public method whose parameters match the specified argument types. (Inherited from Type.)
Public methodGetMethod(String, Type[], ParameterModifier[])Searches for the specified public method whose parameters match the specified argument types and modifiers. (Inherited from Type.)
Public methodGetMethod(String, BindingFlags, Binder, Type[], ParameterModifier[])Searches for the specified method whose parameters match the specified argument types and modifiers, using the specified binding constraints. (Inherited from Type.)
Public methodGetMethod(String, BindingFlags, Binder, CallingConventions, Type[], 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.)
Protected methodGetMethodImplWhen 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.)
Public methodGetMethods()Returns all the public methods of the current Type. (Inherited from Type.)
Public methodGetMethods(BindingFlags)Returns all the public and non-public methods declared or inherited by this type, as specified. (Overrides Type.GetMethods(BindingFlags).)
Public methodGetNestedTypeReturns the specified nested type that is declared by this type. (Overrides Type.GetNestedType(String, BindingFlags).)
Public methodGetNestedTypesReturns the public and non-public nested types that are declared or inherited by this type. (Overrides Type.GetNestedTypes(BindingFlags).)
Public methodGetProperties()Returns all the public properties of the current Type. (Inherited from Type.)
Public methodGetProperties(BindingFlags)Returns all the public and non-public properties declared or inherited by this type, as specified. (Overrides Type.GetProperties(BindingFlags).)
Public methodGetProperty(String)Searches for the public property with the specified name. (Inherited from Type.)
Public methodGetProperty(String, BindingFlags)Searches for the specified property, using the specified binding constraints. (Inherited from Type.)
Public methodGetProperty(String, Type)Searches for the public property with the specified name and return type. (Inherited from Type.)
Public methodGetProperty(String, Type, Type[])Searches for the specified public property whose parameters match the specified argument types. (Inherited from Type.)
Public methodGetProperty(String, Type, Type[], ParameterModifier[])Searches for the specified public property whose parameters match the specified argument types and modifiers. (Inherited from Type.)
Public methodGetProperty(String, BindingFlags, Binder, Type, Type[], ParameterModifier[])Searches for the specified property whose parameters match the specified argument types and modifiers, using the specified binding constraints. (Inherited from Type.)
Protected methodGetPropertyImplWhen 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.)
Public methodGetType()Gets the current Type. (Inherited from Type.)
Protected methodHasElementTypeImplWhen 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.)
Public methodInvokeMember(String, BindingFlags, Binder, Object, Object[])Invokes the specified member, using the specified binding constraints and matching the specified argument list. (Inherited from Type.)
Public methodInvokeMember(String, BindingFlags, Binder, Object, Object[], ParameterModifier[], CultureInfo, 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, Object[], ParameterModifier[], CultureInfo, String[]).)
Protected methodIsArrayImplWhen overridden in a derived class, implements the IsArray property and determines whether the Type is an array. (Inherited from Type.)
Public methodIsAssignableFromDetermines whether an instance of the current Type can be assigned from an instance of the specified Type. (Inherited from Type.)
Protected methodIsByRefImplWhen overridden in a derived class, implements the IsByRef property and determines whether the Type is passed by reference. (Inherited from Type.)
Protected methodIsCOMObjectImplWhen overridden in a derived class, implements the IsCOMObject property and determines whether the Type is a COM object. (Inherited from Type.)
Public methodIsDefinedChecks if the specified custom attribute type is defined. (Overrides MemberInfo.IsDefined(Type, Boolean).)
Public methodIsInstanceOfTypeDetermines whether the specified object is an instance of the current Type. (Inherited from Type.)
Protected methodIsPointerImplWhen overridden in a derived class, implements the IsPointer property and determines whether the Type is a pointer. (Inherited from Type.)
Protected methodIsPrimitiveImplWhen overridden in a derived class, implements the IsPrimitive property and determines whether the Type is one of the primitive types. (Inherited from Type.)
Public methodIsSubclassOfDetermines whether the class represented by the current Type derives from the class represented by the specified Type. (Inherited from Type.)
Protected methodIsValueTypeImplImplements the IsValueType property and determines whether the Type is a value type; that is, not a class or an interface. (Inherited from Type.)
Public methodMakeArrayType()Returns a Type object representing a one-dimensional array of the current type, with a lower bound of zero. (Overrides Type.MakeArrayType().)
Public methodMakeArrayType(Int32)Returns a Type object representing an array of the current type, with the specified number of dimensions. (Overrides Type.MakeArrayType(Int32).)
Public methodMakeByRefTypeReturns a Type object that represents the current type when passed as a ref parameter (ByRef parameter in Visual Basic). (Overrides Type.MakeByRefType().)
Public methodMakeGenericTypeSubstitutes 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.)
Public methodMakePointerTypeReturns a Type object that represents a pointer to the current type. (Overrides Type.MakePointerType().)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSetCustomAttributeSets a custom attribute using a custom attribute builder.
Public methodToStringReturns a String representing the name of the current Type. (Inherited from Type.)
Top

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.

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.


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 
 */


Silverlight

Supported in: 5, 4, 3

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

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

Community Additions

ADD
Show:
© 2014 Microsoft