This topic has not yet been rated - Rate this topic

Assembly.IsDefined Method

.NET Framework 3.0

Other Versions

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

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

Syntax

C++

Copy

public virtual bool IsDefined (
	Type attributeType,
	bool inherit
)

Copy

public boolean IsDefined (
	Type attributeType, 
	boolean inherit
)

JScript

Copy

public function IsDefined (
	attributeType : Type, 
	inherit : boolean
) : boolean

XAML

Copy

Not applicable.

Parameters

attributeType: The Type of the attribute to be checked for this assembly.

inherit: This argument is ignored for objects of this type.

Return Value

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

Exceptions

Exception type	Condition
ArgumentNullException	attributeType is a null reference (Nothing in Visual Basic).
ArgumentException	attributeType uses an invalid type.

Remarks

Note:
In the .NET Framework version 2.0, this method returns true if the assembly has security attributes stored in the new metadata format. Assemblies compiled with version 2.0 use this format. Dynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. See Emitting Declarative Security Attributes.

Example

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.

Copy

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

Platforms

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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.

Version Information

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0

Reference

Assembly Class
Assembly Members
System.Reflection Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ