使用英语阅读

通过

CustomAttributeNamedArgument 结构

  • 参考

定义

命名空间:
System.Reflection
程序集:
mscorlib.dll, System.Reflection.dll
程序集:
netstandard.dll, System.Runtime.dll
程序集:
System.Reflection.dll
程序集:
System.Runtime.dll
程序集:
mscorlib.dll
程序集:
netstandard.dll
Source:
CustomAttributeNamedArgument.cs
Source:
CustomAttributeNamedArgument.cs
Source:
CustomAttributeNamedArgument.cs

表示仅反射上下文中自定义属性的命名参数。

C# 
public struct CustomAttributeNamedArgument
C# 
public readonly struct CustomAttributeNamedArgument : IEquatable<System.Reflection.CustomAttributeNamedArgument>
C# 
public readonly struct CustomAttributeNamedArgument
C# 
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public struct CustomAttributeNamedArgument
继承
Object
ValueType
CustomAttributeNamedArgument
属性
ComVisibleAttribute SerializableAttribute
实现
IEquatable<CustomAttributeNamedArgument>

示例

以下示例定义一个自定义属性，其中包含四个构造函数和四个属性。 其中两个属性是只读的，使用构造函数的位置参数进行设置。 其他两个属性为读/写，只能使用命名参数进行设置。 一个位置属性是字符串数组，一个命名属性是整数数组。

该特性应用于程序集、程序集中声明的类型、类型的方法以及方法的参数。 这些情况使用不同的构造函数。 执行时，程序集将自身加载到仅反射上下文中，并显示有关应用于它的自定义属性及其包含的类型和成员的信息。

应用于该类型的属性演示数组属性，其中包含位置参数和命名参数。

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

注解

无法执行在仅反射上下文中检查的代码，因此并不总是可以通过创建自定义属性的实例，然后使用 Attribute.GetCustomAttributes、MemberInfo.GetCustomAttributes等方法检查自定义属性。 如果特性类型本身的代码加载到仅反射上下文中，则无法执行它。

CustomAttributeNamedArgument 结构由 CustomAttributeData 类用来提供对为自定义属性实例指定的命名参数的访问权限，而无需执行自定义属性类型的相应属性的代码。 TypedValue 属性返回一个 CustomAttributeTypedArgument 结构，该结构包含命名参数的类型和值。

重要

无论是命名参数还是位置参数，都必须使用 CustomAttributeTypedArgument 结构访问其类型和值。

若要创建 CustomAttributeData 类的实例，请使用 staticGetCustomAttributes 工厂方法。

构造函数

CustomAttributeNamedArgument(MemberInfo, CustomAttributeTypedArgument)

初始化 CustomAttributeNamedArgument 类的新实例，该实例表示自定义特性的指定字段或属性，并指定描述字段或属性的类型和值的 CustomAttributeTypedArgument 对象。
CustomAttributeNamedArgument(MemberInfo, Object)

初始化 CustomAttributeNamedArgument 类的新实例，该实例表示自定义属性的指定字段或属性，并指定字段或属性的值。

属性

IsField

获取一个值，该值指示命名参数是否为字段。
MemberInfo

获取将用于设置命名参数的属性成员。
MemberName

获取将用于设置命名参数的属性成员的名称。
TypedValue

获取一个 CustomAttributeTypedArgument 结构，该结构可用于获取当前命名参数的类型和值。

方法

Equals(CustomAttributeNamedArgument)

指示当前实例是否等于同一类型的另一个实例。
Equals(Object)

返回一个值，该值指示此实例是否等于指定对象。
GetHashCode()

返回此实例的哈希代码。
ToString()

返回一个字符串，该字符串由参数名称、等号和参数值的字符串表示形式组成。

运算符

Equality(CustomAttributeNamedArgument, CustomAttributeNamedArgument)

测试两个 CustomAttributeNamedArgument 结构是否等效。
Inequality(CustomAttributeNamedArgument, CustomAttributeNamedArgument)

测试两个 CustomAttributeNamedArgument 结构是否不同。

适用于

产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 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 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

另请参阅