GetCustomAttributes Method (Type, Boolean)
Collapse the table of content
Expand the table of content

Module.GetCustomAttributes Method (Type, Boolean)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Returns custom attributes of the specified type.

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

'Declaration
Public Overridable Function GetCustomAttributes ( _
	attributeType As Type, _
	inherit As Boolean _
) As Object()

Parameters

attributeType
Type: System.Type
The type of attribute to get.
inherit
Type: System.Boolean
This argument is ignored for objects of this type.

Return Value

Type: System.Object ()
An array that contains all custom attributes of the specified type.

Implements

ICustomAttributeProvider.GetCustomAttributes(Type, Boolean)

ExceptionCondition
ArgumentNullException

attributeType is Nothing.

ArgumentException

attributeType is not a Type object supplied by the runtime.

The following example defines an attribute and applies it to the example's module. When the example runs, it retrieves the attributes that were applied to the module and displays them.


Imports System.Reflection

' Define a module-level attribute.
<Module: MySimpleAttribute("module-level")> 

Class Example
    Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
        Dim moduleArray() As [Module] = _
            [Assembly].GetExecutingAssembly().GetModules()
        Dim myModule As [Module] = moduleArray(0)
        Dim attributes() As Object = _
            myModule.GetCustomAttributes(GetType(MySimpleAttribute), True)
        For Each o As Object In attributes
            outputBlock.Text &= _
                String.Format("Found this attribute on myModule: {0}" & vbLf, o.ToString())
        Next o
    End Sub 
End Class 

'A very simple custom attribute.
<AttributeUsage(AttributeTargets.Class Or AttributeTargets.Module)> _
Public Class MySimpleAttribute
    Inherits Attribute
    Private name As String
    Public Sub New(ByVal newName As String)
        name = newName
    End Sub 
End Class 

' This example produces output similar to the following:
'
'Found this attribute on myModule: SilverlightApplication.MySimpleAttribute.


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2017 Microsoft