This documentation is archived and is not being maintained.

CustomAttributeBuilder Class

Helps build custom attributes.

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

[HostProtectionAttribute(SecurityAction::LinkDemand, MayLeakOnAbort = true)]
public ref class CustomAttributeBuilder : _CustomAttributeBuilder


The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. 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.

Use the CustomAttributeBuilder object returned by the constructor to describe the custom attribute. Associate the CustomAttribute with a builder instance by calling the SetCustomAttribute method on that builder instance. For example, create a CustomAttributeBuilder to describe an instance of AssemblyCultureAttribute by supplying the constructor of AssemblyCultureAttribute and its argument. Then call SetCustomAttribute on an AssemblyBuilder to establish the association.

The following code sample illustrates the use of CustomAttributeBuilder.

using namespace System;
using namespace System::Threading;
using namespace System::Reflection;
using namespace System::Reflection::Emit;

// We will apply this custom attribute to our dynamic type. 
public ref class ClassCreator: public Attribute
   String^ creator;


   property String^ Creator 
      String^ get()
         return creator;

   ClassCreator( String^ name )
      this->creator = name;


// We will apply this dynamic attribute to our dynamic method. 
public ref class DateLastUpdated: public Attribute
   String^ dateUpdated;


   property String^ DateUpdated 
      String^ get()
         return dateUpdated;

   DateLastUpdated( String^ theDate )
      this->dateUpdated = theDate;


Type^ BuildTypeWithCustomAttributesOnMethod()
   AppDomain^ currentDomain = Thread::GetDomain();
   AssemblyName^ myAsmName = gcnew AssemblyName;
   myAsmName->Name = "MyAssembly";
   AssemblyBuilder^ myAsmBuilder = currentDomain->DefineDynamicAssembly( myAsmName, AssemblyBuilderAccess::Run );
   ModuleBuilder^ myModBuilder = myAsmBuilder->DefineDynamicModule( "MyModule" );

   // First, we'll build a type with a custom attribute attached.
   TypeBuilder^ myTypeBuilder = myModBuilder->DefineType( "MyType", TypeAttributes::Public );
   array<Type^>^temp6 = {String::typeid};
   array<Type^>^ctorParams = temp6;
   ConstructorInfo^ classCtorInfo = ClassCreator::typeid->GetConstructor( ctorParams );
   array<Object^>^temp0 = {"Joe Programmer"};
   CustomAttributeBuilder^ myCABuilder = gcnew CustomAttributeBuilder( classCtorInfo,temp0 );
   myTypeBuilder->SetCustomAttribute( myCABuilder );

   // Now, let's build a method and add a custom attribute to it. 
   array<Type^>^temp1 = gcnew array<Type^>(0);
   MethodBuilder^ myMethodBuilder = myTypeBuilder->DefineMethod( "HelloWorld", MethodAttributes::Public, nullptr, temp1 );
   array<Type^>^temp7 = {String::typeid};
   ctorParams = temp7;
   classCtorInfo = DateLastUpdated::typeid->GetConstructor( ctorParams );
   array<Object^>^temp2 = {DateTime::Now.ToString()};
   CustomAttributeBuilder^ myCABuilder2 = gcnew CustomAttributeBuilder( classCtorInfo,temp2 );
   myMethodBuilder->SetCustomAttribute( myCABuilder2 );
   ILGenerator^ myIL = myMethodBuilder->GetILGenerator();
   myIL->EmitWriteLine( "Hello, world!" );
   myIL->Emit( OpCodes::Ret );
   return myTypeBuilder->CreateType();

int main()
   Type^ myType = BuildTypeWithCustomAttributesOnMethod();
   Object^ myInstance = Activator::CreateInstance( myType );
   array<Object^>^customAttrs = myType->GetCustomAttributes( true );
   Console::WriteLine( "Custom Attributes for Type 'MyType':" );
   Object^ attrVal = nullptr;
   System::Collections::IEnumerator^ myEnum = customAttrs->GetEnumerator();
   while ( myEnum->MoveNext() )
      Object^ customAttr = safe_cast<Object^>(myEnum->Current);
      array<Object^>^temp3 = gcnew array<Object^>(0);
      attrVal = ClassCreator::typeid->InvokeMember( "Creator", BindingFlags::GetProperty, nullptr, customAttr, temp3 );
      Console::WriteLine( "-- Attribute: [{0} = \"{1}\"]", customAttr, attrVal );

   Console::WriteLine( "Custom Attributes for Method 'HelloWorld()' in 'MyType':" );
   customAttrs = myType->GetMember( "HelloWorld" )[ 0 ]->GetCustomAttributes( true );
   System::Collections::IEnumerator^ myEnum2 = customAttrs->GetEnumerator();
   while ( myEnum2->MoveNext() )
      Object^ customAttr = safe_cast<Object^>(myEnum2->Current);
      array<Object^>^temp4 = gcnew array<Object^>(0);
      attrVal = DateLastUpdated::typeid->InvokeMember( "DateUpdated", BindingFlags::GetProperty, nullptr, customAttr, temp4 );
      Console::WriteLine( "-- Attribute: [{0} = \"{1}\"]", customAttr, attrVal );

   Console::WriteLine( "---" );
   array<Object^>^temp5 = gcnew array<Object^>(0);
   Console::WriteLine( myType->InvokeMember( "HelloWorld", BindingFlags::InvokeMethod, nullptr, myInstance, temp5 ) );


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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0