This documentation is archived and is not being maintained.

CustomAttributeNamedArgument Structure

Represents a named argument of a custom attribute in the reflection-only context.

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

<SerializableAttribute> _
<ComVisibleAttribute(True)> _
Public Structure CustomAttributeNamedArgument
Dim instance As CustomAttributeNamedArgument

/** @attribute SerializableAttribute() */ 
/** @attribute ComVisibleAttribute(true) */ 
public final class CustomAttributeNamedArgument extends ValueType
Not applicable.

Code that is being examined in the reflection-only context cannot be executed, so it is not always possible to examine custom attributes by creating instances of them and then examining their properties, using methods like System.Attribute.GetCustomAttributes, System.Reflection.MemberInfo.GetCustomAttributes, and so on. If the code for the attribute type itself is loaded into the reflection-only context, it cannot be executed.

The CustomAttributeNamedArgument structure is used by the CustomAttributeData class to provide access to a named argument specified for a custom attribute instance, without executing the code of the corresponding property of the custom attribute type. The TypedValue property returns a CustomAttributeTypedArgument structure that contains the type and value of the named argument.

Positional arguments are represented by the CustomAttributeTypedArgument structure.

To create instances of the CustomAttributeData class, use the staticGetCustomAttributes factory method.

The following example defines a custom attribute with four constructors and four properties. Two of the properties are read-only, and are set by using the positional parameters of the constructors. The other two properties are read/write, and can be set only by using named arguments. One positional property is an array of strings, and one named property is an array of integers.

The attribute is applied to the assembly, to a type declared in the assembly, to a method of the type, and to a parameter of the method. Different constructors are used for these cases. When executed, the assembly loads itself into the reflection-only context and displays information about the custom attributes that were applied to it and to the type and members it contains.

The attribute that is applied to the type demonstrates array properties, with both positional and named arguments.

Imports System
Imports System.Reflection
Imports System.Collections.Generic

' 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
End Enum

' An example attribute. The attribute can be applied to all
' targets, from assemblies to parameters.
<AttributeUsage(AttributeTargets.All)> _
Public Class ExampleAttribute
    Inherits Attribute

    ' Data for properties.
    Private kindValue As ExampleKind
    Private noteValue As String

    ' Constructors. The parameterless constructor (.ctor) calls
    ' the constructor that specifies ExampleKind, and supplies the
    ' default value.
    Public Sub New(ByVal initKind As ExampleKind)
        kindValue = initKind
    End Sub
    Public Sub New()
    End Sub

    ' Properties. The Note property must be read/write, so that it can
    ' be used as a named parameter.
    Public ReadOnly Property Kind As ExampleKind
            Return kindValue 
        End Get
    End Property
    Public Property Note As String
            Return noteValue 
        End Get
            noteValue = value
        End Set
    End Property
End Class

' The example attribute is applied to the test class.
<Example(ExampleKind.SecondKind, Note:="This is a note on the class.")> _
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 Sub TestMethod(<Example()> ByVal arg As Object)
    End Sub

    ' Sub 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 Shared Sub Main()
        Dim asm As [Assembly] = Assembly.ReflectionOnlyLoad("Source")
        Dim t As Type = asm.GetType("Test")
        Dim m As MethodInfo = t.GetMethod("TestMethod")
        Dim p() As ParameterInfo = m.GetParameters()

        Console.WriteLine(vbCrLf & "Attributes for assembly: {0}", asm)
        Console.WriteLine(vbCrLf & "Attributes for type: {0}", t)
        Console.WriteLine(vbCrLf & "Attributes for member: {0}", m)
        Console.WriteLine(vbCrLf & "Attributes for parameter: {0}", p)
    End Sub

    Private Shared Sub ShowAttributeData( _
        ByVal attributes As IList(Of CustomAttributeData))

        For Each cad As CustomAttributeData _
            In CType(attributes, IEnumerable(Of CustomAttributeData))

            Console.WriteLine("   {0}", cad)
            Console.WriteLine("      Constructor: {0}", cad.Constructor)

            Console.WriteLine("      Constructor arguments:")
            For Each cata As CustomAttributeTypedArgument _
                In CType(cad.ConstructorArguments, IEnumerable(Of CustomAttributeTypedArgument))

                Console.WriteLine("         Type: {0} Value: {1}", _
                    cata.ArgumentType, cata.Value)

            Console.WriteLine("      Named arguments:")
            For Each cana As CustomAttributeNamedArgument _
                In CType(cad.NamedArguments, IEnumerable(Of CustomAttributeNamedArgument))

                Dim cata As CustomAttributeTypedArgument = _
                Console.WriteLine("         MemberInfo: {0}", _
                Console.WriteLine("         Type: {0} Value: {1}", _
                    cata.ArgumentType, cata.Value)
    End Sub
End Class

' This code example produces output similar to the following:
'Attributes for assembly: source, Version=, Culture=neutral, PublicKeyToken=null
'   [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.
'   [System.Runtime.CompilerServices.CompilationRelaxationsAttribute((Int32)8)]
'      Constructor: Void .ctor(Int32)
'      Constructor arguments:
'         Type: System.Int32 Value: 8
'      Named arguments:
'Attributes for type: Test
'   [ExampleAttribute((ExampleKind)1, Note = "This is a note on the class.")]
'      Constructor: Void .ctor(ExampleKind)
'      Constructor arguments:
'         Type: ExampleKind Value: 1
'      Named arguments:
'         MemberInfo: System.String Note
'         Type: System.String Value: This is a note on the class.
'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:

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 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0