PropertyBuilder Класс

Определение

Пространство имен:

System.Reflection.Emit

Сборка:

System.Reflection.Emit.dll

Исходный код:

PropertyBuilder.cs

Определяет свойства для типа.

public ref class PropertyBuilder abstract : System::Reflection::PropertyInfo

public abstract class PropertyBuilder : System.Reflection.PropertyInfo

type PropertyBuilder = class
    inherit PropertyInfo

Public MustInherit Class PropertyBuilder
Inherits PropertyInfo

Наследование

Object

MemberInfo

PropertyInfo

PropertyBuilder

Примеры

В следующем примере кода показано, как реализовать свойства в динамическом типе с помощью PropertyBuilder , полученного через TypeBuilder.DefineProperty , для создания платформы свойств и связанного MethodBuilder для реализации логики IL в свойстве .

using namespace System;
using namespace System::Threading;
using namespace System::Reflection;
using namespace System::Reflection::Emit;
Type^ BuildDynamicTypeWithProperties()
{
   AppDomain^ myDomain = Thread::GetDomain();
   AssemblyName^ myAsmName = gcnew AssemblyName;
   myAsmName->Name = "MyDynamicAssembly";
   
   // To generate a persistable assembly, specify AssemblyBuilderAccess::RunAndSave.
   AssemblyBuilder^ myAsmBuilder = 
       myDomain->DefineDynamicAssembly( myAsmName, AssemblyBuilderAccess::RunAndSave );
   
   // Generate a persistable single-module assembly.
   ModuleBuilder^ myModBuilder = 
       myAsmBuilder->DefineDynamicModule( myAsmName->Name, myAsmName->Name + ".dll" );
   TypeBuilder^ myTypeBuilder = myModBuilder->DefineType( "CustomerData", TypeAttributes::Public );

   // Define a private field to hold the property value.
   FieldBuilder^ customerNameBldr = myTypeBuilder->DefineField( "customerName", String::typeid, FieldAttributes::Private );
   
   // The last argument of DefineProperty is an empty array of Type
   // objects, because the property has no parameters. (Alternatively,
   // you can specify a null value.)
   PropertyBuilder^ custNamePropBldr = 
       myTypeBuilder->DefineProperty( "CustomerName", PropertyAttributes::HasDefault, String::typeid, gcnew array<Type^>(0) );
   
   // The property set and property get methods require a special
   // set of attributes.
   MethodAttributes getSetAttr = 
       MethodAttributes::Public | MethodAttributes::SpecialName |
           MethodAttributes::HideBySig;

   // Define the "get" accessor method for CustomerName.
   MethodBuilder^ custNameGetPropMthdBldr = 
       myTypeBuilder->DefineMethod( "get_CustomerName", 
                                    getSetAttr,
                                    String::typeid, 
                                    Type::EmptyTypes );

   ILGenerator^ custNameGetIL = custNameGetPropMthdBldr->GetILGenerator();
   custNameGetIL->Emit( OpCodes::Ldarg_0 );
   custNameGetIL->Emit( OpCodes::Ldfld, customerNameBldr );
   custNameGetIL->Emit( OpCodes::Ret );
   
   // Define the "set" accessor method for CustomerName.
   array<Type^>^temp2 = {String::typeid};
   MethodBuilder^ custNameSetPropMthdBldr = 
       myTypeBuilder->DefineMethod( "set_CustomerName", 
                                    getSetAttr,
                                    nullptr, 
                                    temp2 );

   ILGenerator^ custNameSetIL = custNameSetPropMthdBldr->GetILGenerator();
   custNameSetIL->Emit( OpCodes::Ldarg_0 );
   custNameSetIL->Emit( OpCodes::Ldarg_1 );
   custNameSetIL->Emit( OpCodes::Stfld, customerNameBldr );
   custNameSetIL->Emit( OpCodes::Ret );
   
   // Last, we must map the two methods created above to our PropertyBuilder to
   // their corresponding behaviors, "get" and "set" respectively.
   custNamePropBldr->SetGetMethod( custNameGetPropMthdBldr );
   custNamePropBldr->SetSetMethod( custNameSetPropMthdBldr );

   Type^ retval = myTypeBuilder->CreateType();

   // Save the assembly so it can be examined with Ildasm.exe,
   // or referenced by a test program.
   myAsmBuilder->Save(myAsmName->Name + ".dll");
   return retval;
}

int main()
{
   Type^ custDataType = BuildDynamicTypeWithProperties();
   array<PropertyInfo^>^custDataPropInfo = custDataType->GetProperties();
   System::Collections::IEnumerator^ myEnum = custDataPropInfo->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      PropertyInfo^ pInfo = safe_cast<PropertyInfo^>(myEnum->Current);
      Console::WriteLine( "Property '{0}' created!", pInfo );
   }

   Console::WriteLine( "---" );
   
   // Note that when invoking a property, you need to use the proper BindingFlags -
   // BindingFlags::SetProperty when you invoke the "set" behavior, and
   // BindingFlags::GetProperty when you invoke the "get" behavior. Also note that
   // we invoke them based on the name we gave the property, as expected, and not
   // the name of the methods we bound to the specific property behaviors.
   Object^ custData = Activator::CreateInstance( custDataType );
   array<Object^>^temp3 = {"Joe User"};
   custDataType->InvokeMember( "CustomerName", BindingFlags::SetProperty, nullptr, custData, temp3 );
   Console::WriteLine( "The customerName field of instance custData has been set to '{0}'.", custDataType->InvokeMember( "CustomerName", BindingFlags::GetProperty, nullptr, custData, gcnew array<Object^>(0) ) );
}

// --- O U T P U T ---
// The output should be as follows:
// -------------------
// Property 'System.String CustomerName' created!
// ---
// The customerName field of instance custData has been set to 'Joe User'.
// -------------------

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

class PropertyBuilderDemo
{
   public static Type BuildDynamicTypeWithProperties()
   {
        AppDomain myDomain = Thread.GetDomain();
        AssemblyName myAsmName = new AssemblyName();
        myAsmName.Name = "MyDynamicAssembly";

        // To generate a persistable assembly, specify AssemblyBuilderAccess.RunAndSave.
        AssemblyBuilder myAsmBuilder = myDomain.DefineDynamicAssembly(myAsmName,
                                                        AssemblyBuilderAccess.RunAndSave);
        // Generate a persistable single-module assembly.
        ModuleBuilder myModBuilder =
            myAsmBuilder.DefineDynamicModule(myAsmName.Name, myAsmName.Name + ".dll");

        TypeBuilder myTypeBuilder = myModBuilder.DefineType("CustomerData",
                                                        TypeAttributes.Public);

        FieldBuilder customerNameBldr = myTypeBuilder.DefineField("customerName",
                                                        typeof(string),
                                                        FieldAttributes.Private);

        // The last argument of DefineProperty is null, because the
        // property has no parameters. (If you don't specify null, you must
        // specify an array of Type objects. For a parameterless property,
        // use an array with no elements: new Type[] {})
        PropertyBuilder custNamePropBldr = myTypeBuilder.DefineProperty("CustomerName",
                                                         PropertyAttributes.HasDefault,
                                                         typeof(string),
                                                         null);

        // The property set and property get methods require a special
        // set of attributes.
        MethodAttributes getSetAttr =
            MethodAttributes.Public | MethodAttributes.SpecialName |
                MethodAttributes.HideBySig;

        // Define the "get" accessor method for CustomerName.
        MethodBuilder custNameGetPropMthdBldr =
            myTypeBuilder.DefineMethod("get_CustomerName",
                                       getSetAttr,
                                       typeof(string),
                                       Type.EmptyTypes);

        ILGenerator custNameGetIL = custNameGetPropMthdBldr.GetILGenerator();

        custNameGetIL.Emit(OpCodes.Ldarg_0);
        custNameGetIL.Emit(OpCodes.Ldfld, customerNameBldr);
        custNameGetIL.Emit(OpCodes.Ret);

        // Define the "set" accessor method for CustomerName.
        MethodBuilder custNameSetPropMthdBldr =
            myTypeBuilder.DefineMethod("set_CustomerName",
                                       getSetAttr,
                                       null,
                                       new Type[] { typeof(string) });

        ILGenerator custNameSetIL = custNameSetPropMthdBldr.GetILGenerator();

        custNameSetIL.Emit(OpCodes.Ldarg_0);
        custNameSetIL.Emit(OpCodes.Ldarg_1);
        custNameSetIL.Emit(OpCodes.Stfld, customerNameBldr);
        custNameSetIL.Emit(OpCodes.Ret);

        // Last, we must map the two methods created above to our PropertyBuilder to
        // their corresponding behaviors, "get" and "set" respectively.
        custNamePropBldr.SetGetMethod(custNameGetPropMthdBldr);
        custNamePropBldr.SetSetMethod(custNameSetPropMthdBldr);

        Type retval = myTypeBuilder.CreateType();

        // Save the assembly so it can be examined with Ildasm.exe,
        // or referenced by a test program.
        myAsmBuilder.Save(myAsmName.Name + ".dll");
        return retval;
   }

   public static void Main()
   {
        Type custDataType = BuildDynamicTypeWithProperties();

        PropertyInfo[] custDataPropInfo = custDataType.GetProperties();
        foreach (PropertyInfo pInfo in custDataPropInfo) {
           Console.WriteLine("Property '{0}' created!", pInfo.ToString());
        }

        Console.WriteLine("---");
        // Note that when invoking a property, you need to use the proper BindingFlags -
        // BindingFlags.SetProperty when you invoke the "set" behavior, and
        // BindingFlags.GetProperty when you invoke the "get" behavior. Also note that
        // we invoke them based on the name we gave the property, as expected, and not
        // the name of the methods we bound to the specific property behaviors.

        object custData = Activator.CreateInstance(custDataType);
        custDataType.InvokeMember("CustomerName", BindingFlags.SetProperty,
                                      null, custData, new object[]{ "Joe User" });

        Console.WriteLine("The customerName field of instance custData has been set to '{0}'.",
                           custDataType.InvokeMember("CustomerName", BindingFlags.GetProperty,
                                                      null, custData, new object[]{ }));
   }
}

// --- O U T P U T ---
// The output should be as follows:
// -------------------
// Property 'System.String CustomerName' created!
// ---
// The customerName field of instance custData has been set to 'Joe User'.
// -------------------

Imports System.Threading
Imports System.Reflection
Imports System.Reflection.Emit

Class PropertyBuilderDemo
   
   Public Shared Function BuildDynamicTypeWithProperties() As Type
      Dim myDomain As AppDomain = Thread.GetDomain()
      Dim myAsmName As New AssemblyName()
      myAsmName.Name = "MyDynamicAssembly"
      
      ' To generate a persistable assembly, specify AssemblyBuilderAccess.RunAndSave.
      Dim myAsmBuilder As AssemblyBuilder = myDomain.DefineDynamicAssembly(myAsmName, _
                                                        AssemblyBuilderAccess.RunAndSave)
      
      ' Generate a persistable, single-module assembly.
      Dim myModBuilder As ModuleBuilder = _
          myAsmBuilder.DefineDynamicModule(myAsmName.Name, myAsmName.Name & ".dll")
      
      Dim myTypeBuilder As TypeBuilder = myModBuilder.DefineType("CustomerData", TypeAttributes.Public)
      
      ' Define a private field to hold the property value.
      Dim customerNameBldr As FieldBuilder = myTypeBuilder.DefineField("customerName", _
                                             GetType(String), FieldAttributes.Private)
      
      ' The last argument of DefineProperty is Nothing, because the
      ' property has no parameters. (If you don't specify Nothing, you must
      ' specify an array of Type objects. For a parameterless property,
      ' use an array with no elements: New Type() {})
      Dim custNamePropBldr As PropertyBuilder = _
          myTypeBuilder.DefineProperty("CustomerName", _
                                       PropertyAttributes.HasDefault, _
                                       GetType(String), _
                                       Nothing)
      
      ' The property set and property get methods require a special
      ' set of attributes.
      Dim getSetAttr As MethodAttributes = _
          MethodAttributes.Public Or MethodAttributes.SpecialName _
              Or MethodAttributes.HideBySig

      ' Define the "get" accessor method for CustomerName.
      Dim custNameGetPropMthdBldr As MethodBuilder = _
          myTypeBuilder.DefineMethod("GetCustomerName", _
                                     getSetAttr, _
                                     GetType(String), _
                                     Type.EmptyTypes)
      
      Dim custNameGetIL As ILGenerator = custNameGetPropMthdBldr.GetILGenerator()
      
      custNameGetIL.Emit(OpCodes.Ldarg_0)
      custNameGetIL.Emit(OpCodes.Ldfld, customerNameBldr)
      custNameGetIL.Emit(OpCodes.Ret)
      
      ' Define the "set" accessor method for CustomerName.
      Dim custNameSetPropMthdBldr As MethodBuilder = _
          myTypeBuilder.DefineMethod("get_CustomerName", _
                                     getSetAttr, _
                                     Nothing, _
                                     New Type() {GetType(String)})
      
      Dim custNameSetIL As ILGenerator = custNameSetPropMthdBldr.GetILGenerator()
      
      custNameSetIL.Emit(OpCodes.Ldarg_0)
      custNameSetIL.Emit(OpCodes.Ldarg_1)
      custNameSetIL.Emit(OpCodes.Stfld, customerNameBldr)
      custNameSetIL.Emit(OpCodes.Ret)
      
      ' Last, we must map the two methods created above to our PropertyBuilder to 
      ' their corresponding behaviors, "get" and "set" respectively. 
      custNamePropBldr.SetGetMethod(custNameGetPropMthdBldr)
      custNamePropBldr.SetSetMethod(custNameSetPropMthdBldr)
            
      Dim retval As Type = myTypeBuilder.CreateType()

      ' Save the assembly so it can be examined with Ildasm.exe,
      ' or referenced by a test program.
      myAsmBuilder.Save(myAsmName.Name & ".dll")
      return retval
   End Function 'BuildDynamicTypeWithProperties
    
   
   Public Shared Sub Main()
      Dim custDataType As Type = BuildDynamicTypeWithProperties()
      
      Dim custDataPropInfo As PropertyInfo() = custDataType.GetProperties()
      Dim pInfo As PropertyInfo
      For Each pInfo In  custDataPropInfo
         Console.WriteLine("Property '{0}' created!", pInfo.ToString())
      Next pInfo
      
      Console.WriteLine("---")
      ' Note that when invoking a property, you need to use the proper BindingFlags -
      ' BindingFlags.SetProperty when you invoke the "set" behavior, and 
      ' BindingFlags.GetProperty when you invoke the "get" behavior. Also note that
      ' we invoke them based on the name we gave the property, as expected, and not
      ' the name of the methods we bound to the specific property behaviors.
      Dim custData As Object = Activator.CreateInstance(custDataType)
      custDataType.InvokeMember("CustomerName", BindingFlags.SetProperty, Nothing, _
                                custData, New Object() {"Joe User"})
      
      Console.WriteLine("The customerName field of instance custData has been set to '{0}'.", _
                        custDataType.InvokeMember("CustomerName", BindingFlags.GetProperty, _
                        Nothing, custData, New Object() {}))
   End Sub
End Class


' --- O U T P U T ---
' The output should be as follows:
' -------------------
' Property 'System.String CustomerName' created!
' ---
' The customerName field of instance custData has been set to 'Joe User'.
' -------------------

Комментарии

Объект PropertyBuilder всегда связан с TypeBuilder. TypeBuilder. DefineProperty метод вернет клиенту новый PropertyBuilder объект .

Конструкторы

PropertyBuilder()

Инициализирует новый экземпляр класса PropertyBuilder.

Свойства

Attributes	Получает атрибуты данного свойства.
CanRead	Получает значение, указывающее, можно ли выполнить считывание данного свойства.
CanWrite	Получает значение, указывающее, можно ли производить запись в данное свойство.
CustomAttributes	Получает коллекцию, содержащую пользовательские атрибуты этого члена. (Унаследовано от MemberInfo)
DeclaringType	Получает класс, объявляющий этот член.
GetMethod	Получает метод доступа get для этого свойства. (Унаследовано от PropertyInfo)
IsCollectible	Получает значение, указывающее, является ли объект MemberInfo частью сборки, содержащейся в забираемом контексте AssemblyLoadContext. (Унаследовано от MemberInfo)
IsSpecialName	Возвращает значение, указывающее, является ли свойство специальным именем. (Унаследовано от PropertyInfo)
MemberType	Возвращает значение MemberTypes, указывающее, что этот член является свойством. (Унаследовано от PropertyInfo)
MetadataToken	Получает значение, определяющее элемент метаданных. (Унаследовано от MemberInfo)
Module	Возвращает модуль, в котором определяется тип, объявляющий текущее свойство.
Name	Возвращает имя данного элемента.
PropertyType	Возвращает тип поля данного свойства.
ReflectedType	Получает объект класса, который использовался для извлечения данного экземпляра объекта MemberInfo.
SetMethod	Получает метод доступа set для этого свойства. (Унаследовано от PropertyInfo)

Методы

AddOtherMethod(MethodBuilder)	Добавляет один из дополнительных методов, связанных с данным свойством.
AddOtherMethodCore(MethodBuilder)	При переопределении в производном классе добавляет один из других методов, связанных с этим свойством.
Equals(Object)	Возвращает значение, показывающее, равен ли экземпляр указанному объекту. (Унаследовано от PropertyInfo)
GetAccessors()	Возвращает массив, элементы которого отражают открытые методы get и set доступа к свойству, отражаемому текущим экземпляром. (Унаследовано от PropertyInfo)
GetAccessors(Boolean)	Возвращает массив открытых и неоткрытых методов доступа get и set данного свойства.
GetConstantValue()	Метод возвращает значение-литерал, связанное с этим свойством компилятором. (Унаследовано от PropertyInfo)
GetCustomAttributes(Boolean)	Возвращает массив, содержащий все пользовательские атрибуты данного свойства.
GetCustomAttributes(Type, Boolean)	Возвращает массив пользовательских атрибутов, идентифицируемых типом Type.
GetCustomAttributesData()	Возвращает список объектов CustomAttributeData, представляющих данные об атрибутах, примененных к целевому элементу. (Унаследовано от MemberInfo)
GetGetMethod()	Возвращает открытый метод доступа get для данного свойства. (Унаследовано от PropertyInfo)
GetGetMethod(Boolean)	Возвращает открытый и неоткрытый метод доступа get данного свойства.
GetHashCode()	Возвращает хэш-код данного экземпляра. (Унаследовано от PropertyInfo)
GetIndexParameters()	Возвращает массив, содержащий все индексные параметры данного свойства.
GetModifiedPropertyType()	Возвращает измененный тип этого объекта свойства. (Унаследовано от PropertyInfo)
GetOptionalCustomModifiers()	Возвращает массив типов, представляющих необязательные настраиваемые модификаторы для свойства. (Унаследовано от PropertyInfo)
GetRawConstantValue()	Метод возвращает значение-литерал, связанное с этим свойством компилятором. (Унаследовано от PropertyInfo)
GetRequiredCustomModifiers()	Возвращает массив типов, представляющих обязательные настраиваемые модификаторы для свойства. (Унаследовано от PropertyInfo)
GetSetMethod()	Возвращает открытый метод доступа set для данного свойства. (Унаследовано от PropertyInfo)
GetSetMethod(Boolean)	Возвращает метод доступа для этого свойства.
GetType()	Выявляет атрибуты свойства и обеспечивает доступ к его метаданным. (Унаследовано от PropertyInfo)
GetValue(Object)	Возвращает значение свойства указанного объекта. (Унаследовано от PropertyInfo)
GetValue(Object, BindingFlags, Binder, Object[], CultureInfo)	Получает значение свойства в соответствии с указанными связыванием, индексом и объектом CultureInfo.
GetValue(Object, Object[])	Получает значение индексированного свойства через вызов метода чтения данного свойства.
HasSameMetadataDefinitionAs(MemberInfo)	Определяет свойства для типа. (Унаследовано от MemberInfo)
IsDefined(Type, Boolean)	Указывает, определен ли для данного свойства один или несколько экземпляров типа, задаваемого параметром attributeType.
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
SetConstant(Object)	Устанавливает значение, присваиваемое свойству по умолчанию.
SetConstantCore(Object)	При переопределении в производном классе задает значение этого свойства по умолчанию.
SetCustomAttribute(ConstructorInfo, Byte[])	Задает настраиваемый атрибут с помощью большого двоичного объекта настраиваемых атрибутов.
SetCustomAttribute(CustomAttributeBuilder)	Задает настраиваемый атрибут с помощью построителя настраиваемых атрибутов.
SetCustomAttributeCore(ConstructorInfo, ReadOnlySpan<Byte>)	При переопределении в производном классе задает настраиваемый атрибут для этой сборки.
SetGetMethod(MethodBuilder)	Устанавливает метод, который получает значение свойства.
SetGetMethodCore(MethodBuilder)	При переопределении в производном классе задает метод, который получает значение свойства.
SetSetMethod(MethodBuilder)	Устанавливает метод, который задает значение свойства.
SetSetMethodCore(MethodBuilder)	При переопределении в производном классе задает метод , который задает значение свойства .
SetValue(Object, Object)	Задает значение свойства для указанного объекта. (Унаследовано от PropertyInfo)
SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo)	Устанавливает указанное значение для свойства указанного объекта.
SetValue(Object, Object, Object[])	Задает значение свойства с необязательными значениями индекса для свойств индекса.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

Методы расширения

GetCustomAttribute(MemberInfo, Type)	Извлекает пользовательский атрибут заданного типа, примененный к указанному элементу.
GetCustomAttribute(MemberInfo, Type, Boolean)	Извлекает настраиваемый атрибут указанного типа, который применяется к указанному элементу и, при необходимости, проверяет предков этого элемента.
GetCustomAttribute<T>(MemberInfo)	Извлекает пользовательский атрибут заданного типа, примененный к указанному элементу.
GetCustomAttribute<T>(MemberInfo, Boolean)	Извлекает настраиваемый атрибут указанного типа, который применяется к указанному элементу и, при необходимости, проверяет предков этого элемента.
GetCustomAttributes(MemberInfo)	Извлекает коллекцию настраиваемых атрибутов, примененных к указанному члену.
GetCustomAttributes(MemberInfo, Boolean)	Извлекает коллекцию пользовательских атрибутов, которые применяются к указанному элементу и, при необходимости, проверяет предков этого элемента.
GetCustomAttributes(MemberInfo, Type)	Извлекает коллекцию пользовательских атрибутов заданного типа, примененных к указанному элементу.
GetCustomAttributes(MemberInfo, Type, Boolean)	Извлекает коллекцию пользовательских атрибутов указанного типа, которые применяется к указанному элементу и, при необходимости, проверяет предков этого элемента.
GetCustomAttributes<T>(MemberInfo)	Извлекает коллекцию пользовательских атрибутов заданного типа, примененных к указанному элементу.
GetCustomAttributes<T>(MemberInfo, Boolean)	Извлекает коллекцию пользовательских атрибутов указанного типа, которые применяется к указанному элементу и, при необходимости, проверяет предков этого элемента.
IsDefined(MemberInfo, Type)	Указывает, применены ли какие-либо пользовательские атрибуты заданного типа к указанному члену.
IsDefined(MemberInfo, Type, Boolean)	Указывает применены ли настраиваемые атрибуты указанного типа к указанному элементу и, при необходимости, применены ли они к его предкам.
GetMetadataToken(MemberInfo)	Возвращает маркер метаданных для заданного элемента, если он доступен.
HasMetadataToken(MemberInfo)	Возвращает значение, указывающее, доступен ли маркер метаданных для указанного элемента.
GetAccessors(PropertyInfo)	Определяет свойства для типа.
GetAccessors(PropertyInfo, Boolean)	Определяет свойства для типа.
GetGetMethod(PropertyInfo)	Определяет свойства для типа.
GetGetMethod(PropertyInfo, Boolean)	Определяет свойства для типа.
GetSetMethod(PropertyInfo)	Определяет свойства для типа.
GetSetMethod(PropertyInfo, Boolean)	Определяет свойства для типа.