CustomAttributeNamedArgument Estrutura

Definição

Namespace:

System.Reflection

Assemblies:

netstandard.dll, System.Runtime.dll

Origem:

CustomAttributeNamedArgument.cs

Representa um argumento nomeado de um atributo personalizado no contexto somente reflexão.

C#

public readonly struct CustomAttributeNamedArgument : IEquatable<System.Reflection.CustomAttributeNamedArgument>

Herança

Object

ValueType

CustomAttributeNamedArgument

Implementações

IEquatable<CustomAttributeNamedArgument>

Exemplos

O exemplo a seguir define um atributo personalizado com quatro construtores e quatro propriedades. Duas das propriedades são somente leitura e são definidas usando os parâmetros posicionais dos construtores. As outras duas propriedades são de leitura/gravação e só podem ser definidas usando argumentos nomeados. Uma propriedade posicional é uma matriz de cadeias de caracteres e uma propriedade nomeada é uma matriz de inteiros.

O atributo é aplicado ao assembly, a um tipo declarado no assembly, a um método do tipo e a um parâmetro do método. Construtores diferentes são usados para esses casos. Quando executado, o assembly carrega-se no contexto somente reflexão e exibe informações sobre os atributos personalizados que foram aplicados a ele e ao tipo e membros que ele contém.

O atributo aplicado ao tipo demonstra as propriedades da matriz, com argumentos posicionais e nomeados.

C#

using System;
using System.Reflection;
using System.Collections.Generic;
using System.Collections.ObjectModel;

// The example attribute is applied to the assembly.
[assembly:Example(ExampleKind.ThirdKind, Note="This is a note on the assembly.")]

// An enumeration used by the ExampleAttribute class.
public enum ExampleKind
{
    FirstKind,
    SecondKind,
    ThirdKind,
    FourthKind
};

// An example attribute. The attribute can be applied to all
// targets, from assemblies to parameters.
//
[AttributeUsage(AttributeTargets.All)]
public class ExampleAttribute : Attribute
{
    // Data for properties.
    private ExampleKind kindValue;
    private string noteValue;
    private string[] arrayStrings;
    private int[] arrayNumbers;

    // Constructors. The parameterless constructor (.ctor) calls
    // the constructor that specifies ExampleKind and an array of
    // strings, and supplies the default values.
    //
    public ExampleAttribute(ExampleKind initKind, string[] initStrings)
    {
        kindValue = initKind;
        arrayStrings = initStrings;
    }
    public ExampleAttribute(ExampleKind initKind) : this(initKind, null) {}
    public ExampleAttribute() : this(ExampleKind.FirstKind, null) {}

    // Properties. The Note and Numbers properties must be read/write, so they
    // can be used as named parameters.
    //
    public ExampleKind Kind { get { return kindValue; }}
    public string[] Strings { get { return arrayStrings; }}
    public string Note
    {
        get { return noteValue; }
        set { noteValue = value; }
    }
    public int[] Numbers
    {
        get { return arrayNumbers; }
        set { arrayNumbers = value; }
    }
}

// The example attribute is applied to the test class.
//
[Example(ExampleKind.SecondKind,
         new string[] { "String array argument, line 1",
                        "String array argument, line 2",
                        "String array argument, line 3" },
         Note="This is a note on the class.",
         Numbers = new int[] { 53, 57, 59 })]
public class Test
{
    // The example attribute is applied to a method, using the
    // parameterless constructor and supplying a named argument.
    // The attribute is also applied to the method parameter.
    //
    [Example(Note="This is a note on a method.")]
    public void TestMethod([Example] object arg) { }

    // Main() gets objects representing the assembly, the test
    // type, the test method, and the method parameter. Custom
    // attribute data is displayed for each of these.
    //
    public static void Main()
    {
        Assembly asm = Assembly.ReflectionOnlyLoad("Source");
        Type t = asm.GetType("Test");
        MethodInfo m = t.GetMethod("TestMethod");
        ParameterInfo[] p = m.GetParameters();

        Console.WriteLine("\r\nAttributes for assembly: '{0}'", asm);
        ShowAttributeData(CustomAttributeData.GetCustomAttributes(asm));
        Console.WriteLine("\r\nAttributes for type: '{0}'", t);
        ShowAttributeData(CustomAttributeData.GetCustomAttributes(t));
        Console.WriteLine("\r\nAttributes for member: '{0}'", m);
        ShowAttributeData(CustomAttributeData.GetCustomAttributes(m));
        Console.WriteLine("\r\nAttributes for parameter: '{0}'", p);
        ShowAttributeData(CustomAttributeData.GetCustomAttributes(p[0]));
    }

    private static void ShowAttributeData(
        IList<CustomAttributeData> attributes)
    {
        foreach( CustomAttributeData cad in attributes )
        {
            Console.WriteLine("   {0}", cad);
            Console.WriteLine("      Constructor: '{0}'", cad.Constructor);

            Console.WriteLine("      Constructor arguments:");
            foreach( CustomAttributeTypedArgument cata
                in cad.ConstructorArguments )
            {
                ShowValueOrArray(cata);
            }

            Console.WriteLine("      Named arguments:");
            foreach( CustomAttributeNamedArgument cana
                in cad.NamedArguments )
            {
                Console.WriteLine("         MemberInfo: '{0}'",
                    cana.MemberInfo);
                ShowValueOrArray(cana.TypedValue);
            }
        }
    }

    private static void ShowValueOrArray(CustomAttributeTypedArgument cata)
    {
        if (cata.Value.GetType() == typeof(ReadOnlyCollection<CustomAttributeTypedArgument>))
        {
            Console.WriteLine("         Array of '{0}':", cata.ArgumentType);

            foreach (CustomAttributeTypedArgument cataElement in
                (ReadOnlyCollection<CustomAttributeTypedArgument>) cata.Value)
            {
                Console.WriteLine("             Type: '{0}'  Value: '{1}'",
                    cataElement.ArgumentType, cataElement.Value);
            }
        }
        else
        {
            Console.WriteLine("         Type: '{0}'  Value: '{1}'",
                cata.ArgumentType, cata.Value);
        }
    }
}

/* This code example produces output similar to the following:

Attributes for assembly: 'source, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null'
   [System.Runtime.CompilerServices.CompilationRelaxationsAttribute((Int32)8)]
      Constructor: 'Void .ctor(Int32)'
      Constructor arguments:
         Type: 'System.Int32'  Value: '8'
      Named arguments:
   [System.Runtime.CompilerServices.RuntimeCompatibilityAttribute(WrapNonExceptionThrows = True)]
      Constructor: 'Void .ctor()'
      Constructor arguments:
      Named arguments:
         MemberInfo: 'Boolean WrapNonExceptionThrows'
         Type: 'System.Boolean'  Value: 'True'
   [ExampleAttribute((ExampleKind)2, Note = "This is a note on the assembly.")]
      Constructor: 'Void .ctor(ExampleKind)'
      Constructor arguments:
         Type: 'ExampleKind'  Value: '2'
      Named arguments:
         MemberInfo: 'System.String Note'
         Type: 'System.String'  Value: 'This is a note on the assembly.'

Attributes for type: 'Test'
   [ExampleAttribute((ExampleKind)1, new String[3] { "String array argument, line 1", "String array argument, line 2", "String array argument, line 3" }, Note = "This is a note on the class.", Numbers = new Int32[3] { 53, 57, 59 })]
      Constructor: 'Void .ctor(ExampleKind, System.String[])'
      Constructor arguments:
         Type: 'ExampleKind'  Value: '1'
         Array of 'System.String[]':
             Type: 'System.String'  Value: 'String array argument, line 1'
             Type: 'System.String'  Value: 'String array argument, line 2'
             Type: 'System.String'  Value: 'String array argument, line 3'
      Named arguments:
         MemberInfo: 'System.String Note'
         Type: 'System.String'  Value: 'This is a note on the class.'
         MemberInfo: 'Int32[] Numbers'
         Array of 'System.Int32[]':
             Type: 'System.Int32'  Value: '53'
             Type: 'System.Int32'  Value: '57'
             Type: 'System.Int32'  Value: '59'

Attributes for member: 'Void TestMethod(System.Object)'
   [ExampleAttribute(Note = "This is a note on a method.")]
      Constructor: 'Void .ctor()'
      Constructor arguments:
      Named arguments:
         MemberInfo: 'System.String Note'
         Type: 'System.String'  Value: 'This is a note on a method.'

Attributes for parameter: 'System.Object arg'
   [ExampleAttribute()]
      Constructor: 'Void .ctor()'
      Constructor arguments:
      Named arguments:
*/

Comentários

O código que está sendo examinado no contexto somente reflexão não pode ser executado, portanto, nem sempre é possível examinar atributos personalizados criando instâncias deles e examinando suas propriedades, usando métodos como Attribute.GetCustomAttributes, MemberInfo.GetCustomAttributese assim por diante. Se o código do próprio tipo de atributo for carregado no contexto somente reflexão, ele não poderá ser executado.

A estrutura CustomAttributeNamedArgument é usada pela classe CustomAttributeData para fornecer acesso a um argumento nomeado especificado para uma instância de atributo personalizada, sem executar o código da propriedade correspondente do tipo de atributo personalizado. A propriedade TypedValue retorna uma estrutura CustomAttributeTypedArgument que contém o tipo e o valor do argumento nomeado.

Importante

Se um argumento é nomeado ou posicional, você deve acessar seu tipo e valor usando a estrutura CustomAttributeTypedArgument.

Para criar instâncias da classe CustomAttributeData, use o método staticGetCustomAttributes factory.

Construtores

CustomAttributeNamedArgument(MemberInfo, CustomAttributeTypedArgument)	Inicializa uma nova instância da classe CustomAttributeNamedArgument, que representa o campo ou a propriedade especificado do atributo personalizado, e especifica um objeto CustomAttributeTypedArgument que descreve o tipo e o valor do campo ou da propriedade.
CustomAttributeNamedArgument(MemberInfo, Object)	Inicializa uma nova instância da classe CustomAttributeNamedArgument, que representa o campo ou a propriedade especificado do atributo personalizado e especifica o valor do campo ou da propriedade.

Propriedades

IsField	Obtém um valor que indica se o argumento nomeado é um campo.
MemberInfo	Obtém o membro de atributo que seria usado para definir o argumento nomeado.
MemberName	Obtém o nome do membro do atributo que seria usado para definir o argumento nomeado.
TypedValue	Obtém uma estrutura CustomAttributeTypedArgument que pode ser usada para obter o tipo e o valor do argumento nomeado atual.

Métodos

Equals(CustomAttributeNamedArgument)	Indica se a instância atual é igual a outra instância do mesmo tipo.
Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado.
GetHashCode()	Retorna o código hash dessa instância.
ToString()	Retorna uma cadeia de caracteres que consiste no nome do argumento, no sinal de igual e em uma representação de cadeia de caracteres do valor do argumento.

Operadores

Equality(CustomAttributeNamedArgument, CustomAttributeNamedArgument)	Testa se duas estruturas de CustomAttributeNamedArgument são equivalentes.
Inequality(CustomAttributeNamedArgument, CustomAttributeNamedArgument)	Testa se duas estruturas CustomAttributeNamedArgument são diferentes.

Aplica-se a

Confira também

• CustomAttributeData
• CustomAttributeTypedArgument
• ReflectionOnlyLoad