Прочитать на английском

Поделиться через


ParameterInfo.GetCustomAttributes Метод

Определение

Получает все настраиваемые атрибуты, примененные к данному параметру.

Перегрузки

GetCustomAttributes(Type, Boolean)

Получает настраиваемые атрибуты заданного типа или его производных типов, примененные к данному параметру.

GetCustomAttributes(Boolean)

Возвращает все пользовательские атрибуты, определенные для этого параметра.

GetCustomAttributes(Type, Boolean)

Исходный код:
ParameterInfo.cs
Исходный код:
ParameterInfo.cs
Исходный код:
ParameterInfo.cs

Получает настраиваемые атрибуты заданного типа или его производных типов, примененные к данному параметру.

C#
public virtual object[] GetCustomAttributes(Type attributeType, bool inherit);

Параметры

attributeType
Type

Пользовательские атрибуты, идентифицируемые по типу.

inherit
Boolean

Данный аргумент не учитывается для объектов этого типа.

Возвращаемое значение

Object[]

Массив, содержащий настраиваемые атрибуты указанного типа или его производных типов.

Реализации

Исключения

Тип должен быть типом, предоставленным базовой системой среды выполнения.

attributeType имеет значение null.

Не удалось загрузить тип настраиваемого атрибута.

Комментарии

Этот метод игнорирует inherit параметр . Чтобы выполнить поиск атрибутов параметров в цепочке наследования, используйте соответствующие перегрузки Attribute.GetCustomAttributes метода .

Применяется к

.NET 10 и другие версии
Продукт Версии
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

GetCustomAttributes(Boolean)

Исходный код:
ParameterInfo.cs
Исходный код:
ParameterInfo.cs
Исходный код:
ParameterInfo.cs

Возвращает все пользовательские атрибуты, определенные для этого параметра.

C#
public virtual object[] GetCustomAttributes(bool inherit);

Параметры

inherit
Boolean

Данный аргумент не учитывается для объектов этого типа.

Возвращаемое значение

Object[]

Массив, содержащий все настраиваемые атрибуты, примененные к данному параметру.

Реализации

Исключения

Не удалось загрузить тип настраиваемого атрибута.

Примеры

В следующем примере показано, как пользовательские атрибуты, примененные к параметрам методов, можно получить во время выполнения. В примере определяется настраиваемый атрибут с именем MyAttribute , который может применяться к параметрам. Затем в примере определяется класс с именем MyClass с методом с именем MyMethodи применяется MyAttribute к параметру метода .

При выполнении примера он использует GetCustomAttributes(Boolean) метод для получения настраиваемых атрибутов, которые были применены ко всем параметрам всех методов в MyClass, и отображает их в консоли.

C#
using System;
using System.Reflection;

// Define a custom attribute with one named parameter.
[AttributeUsage(AttributeTargets.Parameter)]
public class MyAttribute : Attribute
{
    private string myName;
    public MyAttribute(string name)
    {
        myName = name;
    }
    public string Name
    {
        get
        {
            return myName;
        }
    }
}

// Define a class which has a custom attribute associated with one of the
// parameters of a method.
public class MyClass1
{
    public void MyMethod(
        [MyAttribute("This is an example parameter attribute")]
        int i)
    {
        return;
    }
}

public class MemberInfo_GetCustomAttributes
{
    public static void Main()
    {
        // Get the type of the class 'MyClass1'.
        Type myType = typeof(MyClass1);
        // Get the members associated with the class 'MyClass1'.
        MethodInfo[] myMethods = myType.GetMethods();

        // Display the attributes for each of the parameters of each method of the class 'MyClass1'.
        for(int i = 0; i < myMethods.Length; i++)
        {
            // Get the parameters for the method.
            ParameterInfo[] myParameters = myMethods[i].GetParameters();

            if (myParameters.Length > 0)
            {
                Console.WriteLine("\nThe parameters for the method {0} that have custom attributes are :", myMethods[i]);
                for(int j = 0; j < myParameters.Length; j++)
                {
                    // Get the attributes of type 'MyAttribute' for each parameter.
                    Object[] myAttributes = myParameters[j].GetCustomAttributes(typeof(MyAttribute), false);

                    if (myAttributes.Length > 0)
                    {
                        Console.WriteLine("Parameter {0}, name = {1}, type = {2} has attributes: ",
                            myParameters[j].Position, myParameters[j].Name, myParameters[j].ParameterType);
                        for(int k = 0; k < myAttributes.Length; k++)
                        {
                            Console.WriteLine("\t{0}", myAttributes[k]);
                        }
                    }
                }
            }
        }
    }
}
/* This code example produces the following output:

The parameters for the method Void MyMethod(Int32) that have custom attributes are :
Parameter 0, name = i, type = System.Int32 has attributes:
        MyAttribute

The parameters for the method Boolean Equals(System.Object) that have custom attributes are :
 */

Комментарии

Этот метод игнорирует inherit параметр . Чтобы выполнить поиск атрибутов параметров в цепочке наследования, используйте соответствующие перегрузки Attribute.GetCustomAttributes метода .

Применяется к

.NET 10 и другие версии
Продукт Версии
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1