Assembly.IsDefined(Type, Boolean) Method

Reference

Definition

Namespace:: System.Reflection

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: Assembly.cs

Source:: Assembly.cs

Source:: Assembly.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Indicates whether or not a specified attribute has been applied to the assembly.

public:
 virtual bool IsDefined(Type ^ attributeType, bool inherit);

public virtual bool IsDefined (Type attributeType, bool inherit);

abstract member IsDefined : Type * bool -> bool
override this.IsDefined : Type * bool -> bool

Public Overridable Function IsDefined (attributeType As Type, inherit As Boolean) As Boolean

Parameters

attributeType: Type

The type of the attribute to be checked for this assembly.

inherit: Boolean

This argument is ignored for objects of this type.

Returns

Boolean

true if the attribute has been applied to the assembly; otherwise, false.

Implements

IsDefined(Type, Boolean) IsDefined(Type, Boolean)

Exceptions

ArgumentNullException

attributeType is null.

ArgumentException

attributeType uses an invalid type.

Examples

The following code example applies the AssemblyTitleAttribute attribute to an assembly and then uses IsDefined to indicate whether it was applied. It also tests an attribute that was not applied.

using System;
using System.Reflection;

// Set an assembly attribute.
[assembly:AssemblyTitleAttribute("A title example")]

// Note that the suffix "Attribute" can be omitted:
// [assembly:AssemblyTitle("A title example")]

public class Test {

    public static void Main() {

        // Get the assembly that is executing this method.
        Assembly asm = Assembly.GetCallingAssembly();

        // Get the attribute type just defined.
        Type aType = typeof(AssemblyTitleAttribute);
        Console.WriteLine(asm.IsDefined(aType, false));

        // Try an attribute not defined.
        aType = typeof(AssemblyVersionAttribute);
        Console.WriteLine(asm.IsDefined(aType, false));
    }
}
//
//  This code example produces the following output:
//  True
//  False
//


Imports System.Reflection

' Set an assembly attribute.
<Assembly:AssemblyTitleAttribute("A title example")>

' Note that the suffix "Attribute" can be omitted:
' <Assembly:AssemblyTitle("A title examle")>

Public Class Test
    Public Shared Sub Main()

        ' Get the assembly that is executing this method.
        Dim asm As [Assembly] = [Assembly].GetCallingAssembly

        ' Get the attribute type just defined.
        Dim aType As Type = GetType(AssemblyTitleAttribute)

        Console.WriteLine(asm.IsDefined(aType, false))

        ' Try an attribute not defined.
        aType = GetType(AssemblyVersionAttribute)

        Console.WriteLine(asm.IsDefined(aType, false))

    End Sub
End Class

' This code example produces the following output:
' True
' False
'

Applies to

Share via