Поделиться через

Attribute.IsDefined Метод

Определение

Пространство имен:
System
Сборки:
netstandard.dll, System.Runtime.dll
Сборка:
System.Runtime.dll
Сборка:
mscorlib.dll
Сборка:
netstandard.dll

Определяет, применяются ли пользовательские атрибуты указанного типа к сборке, модулю, элементу типа или параметру метода.

Перегрузки

Имя Описание
IsDefined(ParameterInfo, Type, Boolean)

Определяет, применяются ли пользовательские атрибуты к параметру метода. Параметры указывают параметр метода, тип настраиваемого атрибута для поиска и поиск предков параметра метода.
IsDefined(Module, Type, Boolean)

Определяет, применяются ли пользовательские атрибуты к модулю. Параметры указывают модуль, тип настраиваемого атрибута для поиска и игнорируемый параметр поиска.
IsDefined(MemberInfo, Type, Boolean)

Определяет, применяются ли пользовательские атрибуты к элементу типа. Параметры указывают элемент, тип настраиваемого атрибута для поиска и поиск предков элемента.
IsDefined(Assembly, Type, Boolean)

Определяет, применяются ли пользовательские атрибуты к сборке. Параметры указывают сборку, тип настраиваемого атрибута для поиска и игнорируемый параметр поиска.
IsDefined(MemberInfo, Type)

Определяет, применяются ли пользовательские атрибуты к элементу типа. Параметры указывают элемент и тип настраиваемого атрибута для поиска.
IsDefined(Module, Type)

Определяет, применяются ли к модулю любые пользовательские атрибуты указанного типа. Параметры указывают модуль и тип настраиваемого атрибута для поиска.
IsDefined(Assembly, Type)

Определяет, применяются ли пользовательские атрибуты к сборке. Параметры указывают сборку и тип пользовательского атрибута для поиска.
IsDefined(ParameterInfo, Type)

Определяет, применяются ли пользовательские атрибуты к параметру метода. Параметры указывают параметр метода и тип настраиваемого атрибута для поиска.

IsDefined(ParameterInfo, Type, Boolean)

Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs

Определяет, применяются ли пользовательские атрибуты к параметру метода. Параметры указывают параметр метода, тип настраиваемого атрибута для поиска и поиск предков параметра метода.

public:
 static bool IsDefined(System::Reflection::ParameterInfo ^ element, Type ^ attributeType, bool inherit);
public static bool IsDefined(System.Reflection.ParameterInfo element, Type attributeType, bool inherit);
static member IsDefined : System.Reflection.ParameterInfo * Type * bool -> bool
Public Shared Function IsDefined (element As ParameterInfo, attributeType As Type, inherit As Boolean) As Boolean

Параметры

element
ParameterInfo

Объект, производный от ParameterInfo класса, описывающего параметр члена класса.

attributeType
Type

Тип или базовый тип настраиваемого атрибута для поиска.

inherit
Boolean

Если true, указывает также поиск предков для пользовательских element атрибутов.

Возвращаемое значение

Boolean

trueЗначение , falseесли настраиваемый атрибут типа attributeType применяется к element; в противном случае .

Исключения

ArgumentNullException

element или attributeType есть null.

ArgumentException

attributeType не является производным от Attribute.

ExecutionEngineException

element не является методом, конструктором или типом.

Примеры

В следующем примере кода показано использование IsDefinedпараметра в ParameterInfo качестве параметра.

using System;
using System.Reflection;

namespace IsDef5CS
{
    public class TestClass
    {
        // Assign a ParamArray attribute to the parameter using the keyword.
        public void Method1(params String[] args)
        {}
    }

    public class DemoClass
    {
        static void Main(string[] args)
        {
            // Get the class type to access its metadata.
            Type clsType = typeof(TestClass);
            // Get the MethodInfo object for Method1.
            MethodInfo mInfo = clsType.GetMethod("Method1");
            // Get the ParameterInfo array for the method parameters.
            ParameterInfo[] pInfo = mInfo.GetParameters();
            if (pInfo != null)
            {
                // See if the ParamArray attribute is defined.
                bool isDef = Attribute.IsDefined(pInfo[0],
                                                 typeof(ParamArrayAttribute));
                // Display the result.
                Console.WriteLine("The ParamArray attribute {0} defined for " +
                                  "parameter {1} of method {2}.",
                                  isDef ? "is" : "is not",
                                  pInfo[0].Name,
                                  mInfo.Name);
            }
            else
                Console.WriteLine("The parameters information could " +
                            "not be retrieved for method {0}.", mInfo.Name);
        }
    }
}

/*
 * Output:
 * The ParamArray attribute is defined for parameter args of method Method1.
 */

open System;

type TestClass() =
    // Assign a ParamArray attribute to the parameter.
    member _.Method1([<ParamArray>] args: string[]) = ()

// Get the class type to access its metadata.
let clsType = typeof<TestClass>

// Get the MethodInfo object for Method1.
let mInfo = clsType.GetMethod "Method1"

// Get the ParameterInfo array for the method parameters.
let pInfo = mInfo.GetParameters()

if pInfo <> null then
    // See if the ParamArray attribute is defined.
    let isDef = Attribute.IsDefined(pInfo[0], typeof<ParamArrayAttribute>)

    // Display the result.
    printfn $"""The ParamArray attribute {if isDef then "is" else "is not"} defined for parameter {pInfo[0].Name} of method {mInfo.Name}."""
else
    printfn $"The parameters information could not be retrieved for method {mInfo.Name}."

// Output:
//  The ParamArray attribute is defined for parameter args of method Method1.

Imports System.Reflection

Module DemoModule
    Public Class TestClass
        ' Assign a ParamArray attribute to the parameter using the keyword.
        Public Sub Method1(ByVal ParamArray args As String())
        End Sub
    End Class

    Sub Main()
        ' Get the class type to access its metadata.
        Dim clsType As Type = GetType(TestClass)
        ' Get the MethodInfo object for Method1.
        Dim mInfo As MethodInfo = clsType.GetMethod("Method1")
        ' Get the ParameterInfo array for the method parameters.
        Dim pInfo() As ParameterInfo = mInfo.GetParameters()
        If Not pInfo(0) Is Nothing Then
            ' See if the ParamArray attribute is defined.
            Dim isDef As Boolean = Attribute.IsDefined(pInfo(0), _
                                   GetType(ParamArrayAttribute))
            Dim strDef As String
            If isDef = True Then
                strDef = "is"
            Else
                strDef = "is not"
            End If
            ' Display the result.
            Console.WriteLine("The ParamArray attribute {0} defined " & _
                              "for parameter {1} of method {2}.", _
                              strDef, pInfo(0).Name, mInfo.Name)
        Else
            Console.WriteLine("Could not retrieve parameter information " & _
                              "for method {0}.", mInfo.Name)
        End If
    End Sub
End Module

' Output:
' The ParamArray attribute is defined for parameter args of method Method1.

Применяется к

IsDefined(Module, Type, Boolean)

Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs

Определяет, применяются ли пользовательские атрибуты к модулю. Параметры указывают модуль, тип настраиваемого атрибута для поиска и игнорируемый параметр поиска.

public:
 static bool IsDefined(System::Reflection::Module ^ element, Type ^ attributeType, bool inherit);
public static bool IsDefined(System.Reflection.Module element, Type attributeType, bool inherit);
static member IsDefined : System.Reflection.Module * Type * bool -> bool
Public Shared Function IsDefined (element As Module, attributeType As Type, inherit As Boolean) As Boolean

Параметры

element
Module

Объект, производный от Module класса, описывающего переносимый исполняемый файл.

attributeType
Type

Тип или базовый тип настраиваемого атрибута для поиска.

inherit
Boolean

Этот параметр игнорируется и не влияет на работу этого метода.

Возвращаемое значение

Boolean

trueЗначение , falseесли настраиваемый атрибут типа attributeType применяется к element; в противном случае .

Исключения

ArgumentNullException

element или attributeType есть null.

ArgumentException

attributeType не является производным от Attribute.

Примеры

В следующем примере кода показано использование IsDefinedпараметра в Module качестве параметра.

using System;
using System.Diagnostics;

// Add the Debuggable attribute to the module.
[module:Debuggable(true, false)]
namespace IsDef2CS
{
    public class DemoClass
    {
        static void Main(string[] args)
        {
            // Get the class type to access its metadata.
            Type clsType = typeof(DemoClass);
            // See if the Debuggable attribute is defined for this module.
            bool isDef = Attribute.IsDefined(clsType.Module,
                typeof(DebuggableAttribute));
            // Display the result.
            Console.WriteLine("The Debuggable attribute {0} " +
                "defined for Module {1}.",
                isDef ? "is" : "is not",
                clsType.Module.Name);
            // If the attribute is defined, display the JIT settings.
            if (isDef)
            {
                // Retrieve the attribute itself.
                DebuggableAttribute dbgAttr = (DebuggableAttribute)
                    Attribute.GetCustomAttribute(clsType.Module,
                    typeof(DebuggableAttribute));
                if (dbgAttr != null)
                {
                    Console.WriteLine("JITTrackingEnabled is {0}.",
                        dbgAttr.IsJITTrackingEnabled);
                    Console.WriteLine("JITOptimizerDisabled is {0}.",
                        dbgAttr.IsJITOptimizerDisabled);
                }
                else
                    Console.WriteLine("The Debuggable attribute " +
                        "could not be retrieved.");
            }
        }
    }
}

/*
 * Output:
 * The Debuggable attribute is defined for Module IsDef2CS.exe.
 * JITTrackingEnabled is True.
 * JITOptimizerDisabled is False.
 */

open System
open System.Diagnostics

// Add the Debuggable attribute to the module.
[<``module``: Debuggable(true, false)>]
do ()
    
type DemoClass = class end

// Get the class type to access its metadata.
let clsType = typeof<DemoClass>

// See if the Debuggable attribute is defined for this module.
let isDef = Attribute.IsDefined(clsType.Module, typeof<DebuggableAttribute>)

// Display the result.
printfn $"""The Debuggable attribute {if isDef then "is" else "is not"} defined for Module {clsType.Module.Name}."""

// If the attribute is defined, display the JIT settings.
if isDef then
    // Retrieve the attribute itself.
    let dbgAttr =
        Attribute.GetCustomAttribute(clsType.Module, typeof<DebuggableAttribute>)
        :?> DebuggableAttribute

    if dbgAttr <> null then
        printfn $"JITTrackingEnabled is {dbgAttr.IsJITTrackingEnabled}."
        printfn $"JITOptimizerDisabled is {dbgAttr.IsJITOptimizerDisabled}."            
    else
        printfn "The Debuggable attribute could not be retrieved."

// Output:
//  The Debuggable attribute is defined for Module IsDef2CS.exe.
//  JITTrackingEnabled is True.
//  JITOptimizerDisabled is False.

Imports System.Reflection
Imports System.Diagnostics

' Add the Debuggable attribute to the module.
<Module: Debuggable(True, False)> 

Module DemoModule
    Sub Main()
        ' Get the module type information to access its metadata.
        Dim modType As Type = GetType(DemoModule)
        ' See if the Debuggable attribute is defined.
        Dim isDef As Boolean = Attribute.IsDefined(modType.Module, _
                               GetType(DebuggableAttribute))
        Dim strDef As String
        If isDef = True Then
            strDef = "is"
        Else
            strDef = "is not"
        End If
        ' Display the result
        Console.WriteLine("The debuggable attribute {0} defined for " & _
                          "module {1}.", strDef, modType.Name)
        ' If the attribute is defined, display the JIT settings.
        If isDef = True Then
            ' Retrieve the attribute itself.
            Dim attr As Attribute = _
                Attribute.GetCustomAttribute(modType.Module, _
                GetType(DebuggableAttribute))
            If Not attr Is Nothing And TypeOf attr Is DebuggableAttribute Then
                Dim dbgAttr As DebuggableAttribute = _
                    CType(attr, DebuggableAttribute)
                Console.WriteLine("JITTrackingEnabled is {0}.", _
                    dbgAttr.IsJITTrackingEnabled.ToString())
                Console.WriteLine("JITOptimizerDisabled is {0}.", _
                    dbgAttr.IsJITOptimizerDisabled.ToString())
            Else
                Console.WriteLine("The Debuggable attribute could " & _
                                  "not be retrieved.")
            End If
        End If
    End Sub
End Module

' Output:
' The debuggable attribute is defined for module DemoModule.
' JITTrackingEnabled is True.
' JITOptimizerDisabled is False.

Комментарии

Этот метод игнорирует inherit параметр и не выполняет поиск предков для пользовательских element атрибутов.

Применяется к

IsDefined(MemberInfo, Type, Boolean)

Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs

Определяет, применяются ли пользовательские атрибуты к элементу типа. Параметры указывают элемент, тип настраиваемого атрибута для поиска и поиск предков элемента.

public:
 static bool IsDefined(System::Reflection::MemberInfo ^ element, Type ^ attributeType, bool inherit);
public static bool IsDefined(System.Reflection.MemberInfo element, Type attributeType, bool inherit);
static member IsDefined : System.Reflection.MemberInfo * Type * bool -> bool
Public Shared Function IsDefined (element As MemberInfo, attributeType As Type, inherit As Boolean) As Boolean

Параметры

element
MemberInfo

Объект, производный от MemberInfo класса, описывающего конструктор, событие, поле, метод, тип или элемент свойства класса.

attributeType
Type

Тип или базовый тип настраиваемого атрибута для поиска.

inherit
Boolean

Если true, указывает также поиск предков для пользовательских element атрибутов.

Возвращаемое значение

Boolean

trueЗначение , falseесли настраиваемый атрибут типа attributeType применяется к element; в противном случае .

Исключения

ArgumentNullException

element или attributeType есть null.

ArgumentException

attributeType не является производным от Attribute.

NotSupportedException

element не является конструктором, методом, свойством, событием, типом или полем.

Примеры

В следующем примере кода показано использование IsDefinedпараметра в MemberInfo качестве параметра.

using System;
using System.Reflection;

namespace IsDef4CS
{
    public class TestClass
    {
        // Assign the Obsolete attribute to a method.
        [Obsolete("This method is obsolete. Use Method2 instead.")]
        public void Method1()
        {}
        public void Method2()
        {}
    }

    public class DemoClass
    {
        static void Main(string[] args)
        {
            // Get the class type to access its metadata.
            Type clsType = typeof(TestClass);
            // Get the MethodInfo object for Method1.
            MethodInfo mInfo = clsType.GetMethod("Method1");
            // See if the Obsolete attribute is defined for this method.
            bool isDef = Attribute.IsDefined(mInfo, typeof(ObsoleteAttribute));
            // Display the result.
            Console.WriteLine("The Obsolete Attribute {0} defined for {1} of class {2}.",
                isDef ? "is" : "is not", mInfo.Name, clsType.Name);
            // If it's defined, display the attribute's message.
            if (isDef)
            {
                ObsoleteAttribute obsAttr =
                                 (ObsoleteAttribute)Attribute.GetCustomAttribute(
                                                    mInfo, typeof(ObsoleteAttribute));
                if (obsAttr != null)
                    Console.WriteLine("The message is: \"{0}\".",
                        obsAttr.Message);
                else
                    Console.WriteLine("The message could not be retrieved.");
            }
        }
    }
}

/*
 * Output:
 * The Obsolete Attribute is defined for Method1 of class TestClass.
 * The message is: "This method is obsolete. Use Method2 instead.".
 */

open System

type TestClass() =
    // Assign the Obsolete attribute to a method.
    [<Obsolete "This method is obsolete. Use Method2 instead.">]
    member _.Method1() = ()
    member _.Method2() = ()

// Get the class type to access its metadata.
let clsType = typeof<TestClass>

// Get the MethodInfo object for Method1.
let mInfo = clsType.GetMethod "Method1"

// See if the Obsolete attribute is defined for this method.
let isDef = Attribute.IsDefined(mInfo, typeof<ObsoleteAttribute>)

// Display the result.
printfn $"""The Obsolete Attribute {if isDef then "is" else "is not"} defined for {mInfo.Name} of class {clsType.Name}."""

// If it's defined, display the attribute's message.
if isDef then
    let obsAttr =
        Attribute.GetCustomAttribute(mInfo, typeof<ObsoleteAttribute>)
        :?> ObsoleteAttribute
    if obsAttr <> null then
        printfn $"The message is: \"{obsAttr.Message}\"."
    else
        printfn "The message could not be retrieved."

// Output:
//  The Obsolete Attribute is defined for Method1 of class TestClass.
// The message is: "This method is obsolete. Use Method2 instead.".

Imports System.Reflection

Module DemoModule

    Public Class TestClass
        ' Assign the Obsolete attribute to a method.
        <Obsolete("This method is obsolete. Use Method2() instead.")> _
        Public Sub Method1()
        End Sub

        Public Sub Method2()
        End Sub
    End Class

    Sub Main()
        ' Get the class type to access its metadata.
        Dim clsType As Type = GetType(TestClass)
        ' Get the MethodInfo object for Method1.
        Dim mInfo As MethodInfo = clsType.GetMethod("Method1")
        ' See if the Obsolete attribute is defined for this method.
        Dim isDef As Boolean = Attribute.IsDefined(mInfo, _
            GetType(ObsoleteAttribute))
        Dim strDef As String
        If isDef = True Then
            strDef = "is"
        Else
            strDef = "is not"
        End If
        ' Display the results.
        Console.WriteLine("The Obsolete attribute {0} defined for " & _
            "method {1} of class {2}.", strDef, mInfo.Name, clsType.Name)
        ' If it's defined, display the attribute's message.
        If isDef = True Then
            Dim attr As Attribute = Attribute.GetCustomAttribute(mInfo, _
                GetType(ObsoleteAttribute))
            If Not attr Is Nothing And TypeOf attr Is ObsoleteAttribute Then
                Dim obsAttr As ObsoleteAttribute = _
                    CType(attr, ObsoleteAttribute)
                Console.WriteLine("The message is: ""{0}""", obsAttr.Message)
            Else
                Console.WriteLine("The message could not be retrieved.")
            End If
        End If
    End Sub
End Module

' Output:
' The Obsolete attribute is defined for method Method1 of class TestClass.
' The message is: "This method is obsolete. Use Method2() instead."

Комментарии

Замечание

Начиная с версии .NET Framework версии 2.0 этот метод возвращает true, если тип, метод или конструктор имеют атрибуты безопасности, хранящиеся в новом формате метаданных. Сборки, скомпилированные с версией 2.0 или более поздней, используют новый формат.

Применяется к

IsDefined(Assembly, Type, Boolean)

Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs

Определяет, применяются ли пользовательские атрибуты к сборке. Параметры указывают сборку, тип настраиваемого атрибута для поиска и игнорируемый параметр поиска.

public:
 static bool IsDefined(System::Reflection::Assembly ^ element, Type ^ attributeType, bool inherit);
public static bool IsDefined(System.Reflection.Assembly element, Type attributeType, bool inherit);
static member IsDefined : System.Reflection.Assembly * Type * bool -> bool
Public Shared Function IsDefined (element As Assembly, attributeType As Type, inherit As Boolean) As Boolean

Параметры

element
Assembly

Объект, производный от Assembly класса, описывающего повторно используемый набор модулей.

attributeType
Type

Тип или базовый тип настраиваемого атрибута для поиска.

inherit
Boolean

Этот параметр игнорируется и не влияет на работу этого метода.

Возвращаемое значение

Boolean

trueЗначение , falseесли настраиваемый атрибут типа attributeType применяется к element; в противном случае .

Исключения

ArgumentNullException

element или attributeType есть null.

ArgumentException

attributeType не является производным от Attribute.

Примеры

В следующем примере кода показано использование IsDefined, принимая в Assembly качестве параметра.

using System;
using System.Reflection;

// Add an AssemblyDescription attribute
[assembly: AssemblyDescription("A sample description")]
namespace IsDef1CS
{
    public class DemoClass
    {
        static void Main(string[] args)
        {
            // Get the class type to access its metadata.
            Type clsType = typeof(DemoClass);
            // Get the assembly object.
            Assembly assy = clsType.Assembly;
            // Store the assembly's name.
            String assyName = assy.GetName().Name;
            // See if the Assembly Description is defined.
            bool isdef = Attribute.IsDefined(assy,
                typeof(AssemblyDescriptionAttribute));
            if (isdef)
            {
                // Affirm that the attribute is defined.
                Console.WriteLine("The AssemblyDescription attribute " +
                    "is defined for assembly {0}.", assyName);
                // Get the description attribute itself.
                AssemblyDescriptionAttribute adAttr =
                    (AssemblyDescriptionAttribute)Attribute.GetCustomAttribute(
                    assy, typeof(AssemblyDescriptionAttribute));
                // Display the description.
                if (adAttr != null)
                    Console.WriteLine("The description is \"{0}\".",
                        adAttr.Description);
                else
                    Console.WriteLine("The description could not " +
                        "be retrieved.");
            }
            else
                Console.WriteLine("The AssemblyDescription attribute is not " +
                    "defined for assembly {0}.", assyName);
        }
    }
}

/*
 * Output:
 * The AssemblyDescription attribute is defined for assembly IsDef1CS.
 * The description is "A sample description".
 */

open System
open System.Reflection

// Add an AssemblyDescription attribute
[<assembly: AssemblyDescription "A sample description">]
do ()

type DemoClass = class end

// Get the class type to access its metadata.
let clsType = typeof<DemoClass>

// Get the assembly object.
let assembly = clsType.Assembly;

// Store the assembly's name.
let assemblyName = assembly.GetName().Name

// See if the Assembly Description is defined.
let isdef = 
    Attribute.IsDefined(assembly, typeof<AssemblyDescriptionAttribute>)

if isdef then
    // Affirm that the attribute is defined.
    printfn $"The AssemblyDescription attribute is defined for assembly {assemblyName}."
    
    // Get the description attribute itself.
    let adAttr =
        Attribute.GetCustomAttribute(assembly, typeof<AssemblyDescriptionAttribute>)
        :?> AssemblyDescriptionAttribute

    // Display the description.
    if adAttr <> null then
        printfn $"The description is \"{adAttr.Description}\"."
    else
        printfn $"The description could not be retrieved."
else
    printfn $"The AssemblyDescription attribute is not defined for assembly {assemblyName}."

// Output:
//  The AssemblyDescription attribute is defined for assembly IsDef1FS.
//  The description is "A sample description".

Imports System.Reflection

' Add an AssemblyDescription attribute.
<Assembly: AssemblyDescription("A sample description")> 

Module DemoModule
    Sub Main()
        ' Get the assembly for this module.
        Dim assy As System.Reflection.Assembly = GetType(DemoModule).Assembly
        ' Store the assembly name.
        Dim assyName As String = assy.GetName().Name
        ' See if the AssemblyDescription attribute is defined.
        If Attribute.IsDefined(assy, GetType(AssemblyDescriptionAttribute)) _
            Then
            ' Affirm that the attribute is defined. Assume the filename of
            ' this code example is "IsDef1VB".
            Console.WriteLine("The AssemblyDescription attribute is " & _
                "defined for assembly {0}.", assyName)
            ' Get the description attribute itself.
            Dim attr As Attribute = Attribute.GetCustomAttribute( _
                assy, GetType(AssemblyDescriptionAttribute))
            ' Display the description.
            If Not attr Is Nothing And _
                TypeOf attr Is AssemblyDescriptionAttribute Then
                Dim adAttr As AssemblyDescriptionAttribute = _
                    CType(attr, AssemblyDescriptionAttribute)
                Console.WriteLine("The description is " & _
                    Chr(34) & "{0}" & Chr(34) & ".", adAttr.Description)
            Else
                Console.WriteLine("The description could not be retrieved.")
            End If
        Else
            Console.WriteLine("The AssemblyDescription attribute is not " & _
                              "defined for assembly {0}.", assyName)
        End If
    End Sub
End Module

' Output:
' The AssemblyDescription attribute is defined for assembly IsDef1VB.
' The description is "A sample description".

Комментарии

Замечание

Начиная с версии .NET Framework версии 2.0 этот метод возвращает true, если сборка имеет атрибуты безопасности, хранящиеся в новом формате метаданных. Сборки, скомпилированные с версией 2.0 или более поздней, используют новый формат.

Применяется к

IsDefined(MemberInfo, Type)

Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs

Определяет, применяются ли пользовательские атрибуты к элементу типа. Параметры указывают элемент и тип настраиваемого атрибута для поиска.

public:
 static bool IsDefined(System::Reflection::MemberInfo ^ element, Type ^ attributeType);
public static bool IsDefined(System.Reflection.MemberInfo element, Type attributeType);
static member IsDefined : System.Reflection.MemberInfo * Type -> bool
Public Shared Function IsDefined (element As MemberInfo, attributeType As Type) As Boolean

Параметры

element
MemberInfo

Объект, производный от MemberInfo класса, описывающего конструктор, событие, поле, метод, тип или элемент свойства класса.

attributeType
Type

Тип или базовый тип настраиваемого атрибута для поиска.

Возвращаемое значение

Boolean

trueЗначение , falseесли настраиваемый атрибут типа attributeType применяется к element; в противном случае .

Исключения

ArgumentNullException

element или attributeType есть null.

ArgumentException

attributeType не является производным от Attribute.

NotSupportedException

element не является конструктором, методом, свойством, событием, типом или полем.

Примеры

В следующем примере кода показано использование IsDefinedпараметра в MemberInfo качестве параметра.

using System;
using System.Reflection;

namespace IsDef4CS
{
    public class TestClass
    {
        // Assign the Obsolete attribute to a method.
        [Obsolete("This method is obsolete. Use Method2 instead.")]
        public void Method1()
        {}
        public void Method2()
        {}
    }

    public class DemoClass
    {
        static void Main(string[] args)
        {
            // Get the class type to access its metadata.
            Type clsType = typeof(TestClass);
            // Get the MethodInfo object for Method1.
            MethodInfo mInfo = clsType.GetMethod("Method1");
            // See if the Obsolete attribute is defined for this method.
            bool isDef = Attribute.IsDefined(mInfo, typeof(ObsoleteAttribute));
            // Display the result.
            Console.WriteLine("The Obsolete Attribute {0} defined for {1} of class {2}.",
                isDef ? "is" : "is not", mInfo.Name, clsType.Name);
            // If it's defined, display the attribute's message.
            if (isDef)
            {
                ObsoleteAttribute obsAttr =
                                 (ObsoleteAttribute)Attribute.GetCustomAttribute(
                                                    mInfo, typeof(ObsoleteAttribute));
                if (obsAttr != null)
                    Console.WriteLine("The message is: \"{0}\".",
                        obsAttr.Message);
                else
                    Console.WriteLine("The message could not be retrieved.");
            }
        }
    }
}

/*
 * Output:
 * The Obsolete Attribute is defined for Method1 of class TestClass.
 * The message is: "This method is obsolete. Use Method2 instead.".
 */

open System

type TestClass() =
    // Assign the Obsolete attribute to a method.
    [<Obsolete "This method is obsolete. Use Method2 instead.">]
    member _.Method1() = ()
    member _.Method2() = ()

// Get the class type to access its metadata.
let clsType = typeof<TestClass>

// Get the MethodInfo object for Method1.
let mInfo = clsType.GetMethod "Method1"

// See if the Obsolete attribute is defined for this method.
let isDef = Attribute.IsDefined(mInfo, typeof<ObsoleteAttribute>)

// Display the result.
printfn $"""The Obsolete Attribute {if isDef then "is" else "is not"} defined for {mInfo.Name} of class {clsType.Name}."""

// If it's defined, display the attribute's message.
if isDef then
    let obsAttr =
        Attribute.GetCustomAttribute(mInfo, typeof<ObsoleteAttribute>)
        :?> ObsoleteAttribute
    if obsAttr <> null then
        printfn $"The message is: \"{obsAttr.Message}\"."
    else
        printfn "The message could not be retrieved."

// Output:
//  The Obsolete Attribute is defined for Method1 of class TestClass.
// The message is: "This method is obsolete. Use Method2 instead.".

Imports System.Reflection

Module DemoModule

    Public Class TestClass
        ' Assign the Obsolete attribute to a method.
        <Obsolete("This method is obsolete. Use Method2() instead.")> _
        Public Sub Method1()
        End Sub

        Public Sub Method2()
        End Sub
    End Class

    Sub Main()
        ' Get the class type to access its metadata.
        Dim clsType As Type = GetType(TestClass)
        ' Get the MethodInfo object for Method1.
        Dim mInfo As MethodInfo = clsType.GetMethod("Method1")
        ' See if the Obsolete attribute is defined for this method.
        Dim isDef As Boolean = Attribute.IsDefined(mInfo, _
            GetType(ObsoleteAttribute))
        Dim strDef As String
        If isDef = True Then
            strDef = "is"
        Else
            strDef = "is not"
        End If
        ' Display the results.
        Console.WriteLine("The Obsolete attribute {0} defined for " & _
            "method {1} of class {2}.", strDef, mInfo.Name, clsType.Name)
        ' If it's defined, display the attribute's message.
        If isDef = True Then
            Dim attr As Attribute = Attribute.GetCustomAttribute(mInfo, _
                GetType(ObsoleteAttribute))
            If Not attr Is Nothing And TypeOf attr Is ObsoleteAttribute Then
                Dim obsAttr As ObsoleteAttribute = _
                    CType(attr, ObsoleteAttribute)
                Console.WriteLine("The message is: ""{0}""", obsAttr.Message)
            Else
                Console.WriteLine("The message could not be retrieved.")
            End If
        End If
    End Sub
End Module

' Output:
' The Obsolete attribute is defined for method Method1 of class TestClass.
' The message is: "This method is obsolete. Use Method2() instead."

Комментарии

Предки ищут пользовательские атрибуты element .

Замечание

Начиная с версии .NET Framework версии 2.0 этот метод возвращает true, если тип, метод или конструктор имеют атрибуты безопасности, хранящиеся в новом формате метаданных. Сборки, скомпилированные с версией 2.0 или более поздней, используют новый формат.

Применяется к

IsDefined(Module, Type)

Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs

Определяет, применяются ли к модулю любые пользовательские атрибуты указанного типа. Параметры указывают модуль и тип настраиваемого атрибута для поиска.

public:
 static bool IsDefined(System::Reflection::Module ^ element, Type ^ attributeType);
public static bool IsDefined(System.Reflection.Module element, Type attributeType);
static member IsDefined : System.Reflection.Module * Type -> bool
Public Shared Function IsDefined (element As Module, attributeType As Type) As Boolean

Параметры

element
Module

Объект, производный от Module класса, описывающего переносимый исполняемый файл.

attributeType
Type

Тип или базовый тип настраиваемого атрибута для поиска.

Возвращаемое значение

Boolean

trueЗначение , falseесли настраиваемый атрибут типа attributeType применяется к element; в противном случае .

Исключения

ArgumentNullException

element или attributeType есть null.

ArgumentException

attributeType не является производным от Attribute.

Примеры

В следующем примере кода показано использование IsDefinedпараметра в Module качестве параметра.

using System;
using System.Diagnostics;

// Add the Debuggable attribute to the module.
[module:Debuggable(true, false)]
namespace IsDef2CS
{
    public class DemoClass
    {
        static void Main(string[] args)
        {
            // Get the class type to access its metadata.
            Type clsType = typeof(DemoClass);
            // See if the Debuggable attribute is defined for this module.
            bool isDef = Attribute.IsDefined(clsType.Module,
                typeof(DebuggableAttribute));
            // Display the result.
            Console.WriteLine("The Debuggable attribute {0} " +
                "defined for Module {1}.",
                isDef ? "is" : "is not",
                clsType.Module.Name);
            // If the attribute is defined, display the JIT settings.
            if (isDef)
            {
                // Retrieve the attribute itself.
                DebuggableAttribute dbgAttr = (DebuggableAttribute)
                    Attribute.GetCustomAttribute(clsType.Module,
                    typeof(DebuggableAttribute));
                if (dbgAttr != null)
                {
                    Console.WriteLine("JITTrackingEnabled is {0}.",
                        dbgAttr.IsJITTrackingEnabled);
                    Console.WriteLine("JITOptimizerDisabled is {0}.",
                        dbgAttr.IsJITOptimizerDisabled);
                }
                else
                    Console.WriteLine("The Debuggable attribute " +
                        "could not be retrieved.");
            }
        }
    }
}

/*
 * Output:
 * The Debuggable attribute is defined for Module IsDef2CS.exe.
 * JITTrackingEnabled is True.
 * JITOptimizerDisabled is False.
 */

open System
open System.Diagnostics

// Add the Debuggable attribute to the module.
[<``module``: Debuggable(true, false)>]
do ()
    
type DemoClass = class end

// Get the class type to access its metadata.
let clsType = typeof<DemoClass>

// See if the Debuggable attribute is defined for this module.
let isDef = Attribute.IsDefined(clsType.Module, typeof<DebuggableAttribute>)

// Display the result.
printfn $"""The Debuggable attribute {if isDef then "is" else "is not"} defined for Module {clsType.Module.Name}."""

// If the attribute is defined, display the JIT settings.
if isDef then
    // Retrieve the attribute itself.
    let dbgAttr =
        Attribute.GetCustomAttribute(clsType.Module, typeof<DebuggableAttribute>)
        :?> DebuggableAttribute

    if dbgAttr <> null then
        printfn $"JITTrackingEnabled is {dbgAttr.IsJITTrackingEnabled}."
        printfn $"JITOptimizerDisabled is {dbgAttr.IsJITOptimizerDisabled}."            
    else
        printfn "The Debuggable attribute could not be retrieved."

// Output:
//  The Debuggable attribute is defined for Module IsDef2CS.exe.
//  JITTrackingEnabled is True.
//  JITOptimizerDisabled is False.

Imports System.Reflection
Imports System.Diagnostics

' Add the Debuggable attribute to the module.
<Module: Debuggable(True, False)> 

Module DemoModule
    Sub Main()
        ' Get the module type information to access its metadata.
        Dim modType As Type = GetType(DemoModule)
        ' See if the Debuggable attribute is defined.
        Dim isDef As Boolean = Attribute.IsDefined(modType.Module, _
                               GetType(DebuggableAttribute))
        Dim strDef As String
        If isDef = True Then
            strDef = "is"
        Else
            strDef = "is not"
        End If
        ' Display the result
        Console.WriteLine("The debuggable attribute {0} defined for " & _
                          "module {1}.", strDef, modType.Name)
        ' If the attribute is defined, display the JIT settings.
        If isDef = True Then
            ' Retrieve the attribute itself.
            Dim attr As Attribute = _
                Attribute.GetCustomAttribute(modType.Module, _
                GetType(DebuggableAttribute))
            If Not attr Is Nothing And TypeOf attr Is DebuggableAttribute Then
                Dim dbgAttr As DebuggableAttribute = _
                    CType(attr, DebuggableAttribute)
                Console.WriteLine("JITTrackingEnabled is {0}.", _
                    dbgAttr.IsJITTrackingEnabled.ToString())
                Console.WriteLine("JITOptimizerDisabled is {0}.", _
                    dbgAttr.IsJITOptimizerDisabled.ToString())
            Else
                Console.WriteLine("The Debuggable attribute could " & _
                                  "not be retrieved.")
            End If
        End If
    End Sub
End Module

' Output:
' The debuggable attribute is defined for module DemoModule.
' JITTrackingEnabled is True.
' JITOptimizerDisabled is False.

Комментарии

Предки не ищут пользовательские атрибуты element .

Применяется к

IsDefined(Assembly, Type)

Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs

Определяет, применяются ли пользовательские атрибуты к сборке. Параметры указывают сборку и тип пользовательского атрибута для поиска.

public:
 static bool IsDefined(System::Reflection::Assembly ^ element, Type ^ attributeType);
public static bool IsDefined(System.Reflection.Assembly element, Type attributeType);
static member IsDefined : System.Reflection.Assembly * Type -> bool
Public Shared Function IsDefined (element As Assembly, attributeType As Type) As Boolean

Параметры

element
Assembly

Объект, производный от Assembly класса, описывающего повторно используемый набор модулей.

attributeType
Type

Тип или базовый тип настраиваемого атрибута для поиска.

Возвращаемое значение

Boolean

trueЗначение , falseесли настраиваемый атрибут типа attributeType применяется к element; в противном случае .

Исключения

ArgumentNullException

element или attributeType есть null.

ArgumentException

attributeType не является производным от Attribute.

Примеры

В следующем примере кода показано использование IsDefined, принимая в Assembly качестве параметра.

using System;
using System.Reflection;

// Add an AssemblyDescription attribute
[assembly: AssemblyDescription("A sample description")]
namespace IsDef1CS
{
    public class DemoClass
    {
        static void Main(string[] args)
        {
            // Get the class type to access its metadata.
            Type clsType = typeof(DemoClass);
            // Get the assembly object.
            Assembly assy = clsType.Assembly;
            // Store the assembly's name.
            String assyName = assy.GetName().Name;
            // See if the Assembly Description is defined.
            bool isdef = Attribute.IsDefined(assy,
                typeof(AssemblyDescriptionAttribute));
            if (isdef)
            {
                // Affirm that the attribute is defined.
                Console.WriteLine("The AssemblyDescription attribute " +
                    "is defined for assembly {0}.", assyName);
                // Get the description attribute itself.
                AssemblyDescriptionAttribute adAttr =
                    (AssemblyDescriptionAttribute)Attribute.GetCustomAttribute(
                    assy, typeof(AssemblyDescriptionAttribute));
                // Display the description.
                if (adAttr != null)
                    Console.WriteLine("The description is \"{0}\".",
                        adAttr.Description);
                else
                    Console.WriteLine("The description could not " +
                        "be retrieved.");
            }
            else
                Console.WriteLine("The AssemblyDescription attribute is not " +
                    "defined for assembly {0}.", assyName);
        }
    }
}

/*
 * Output:
 * The AssemblyDescription attribute is defined for assembly IsDef1CS.
 * The description is "A sample description".
 */

open System
open System.Reflection

// Add an AssemblyDescription attribute
[<assembly: AssemblyDescription "A sample description">]
do ()

type DemoClass = class end

// Get the class type to access its metadata.
let clsType = typeof<DemoClass>

// Get the assembly object.
let assembly = clsType.Assembly;

// Store the assembly's name.
let assemblyName = assembly.GetName().Name

// See if the Assembly Description is defined.
let isdef = 
    Attribute.IsDefined(assembly, typeof<AssemblyDescriptionAttribute>)

if isdef then
    // Affirm that the attribute is defined.
    printfn $"The AssemblyDescription attribute is defined for assembly {assemblyName}."
    
    // Get the description attribute itself.
    let adAttr =
        Attribute.GetCustomAttribute(assembly, typeof<AssemblyDescriptionAttribute>)
        :?> AssemblyDescriptionAttribute

    // Display the description.
    if adAttr <> null then
        printfn $"The description is \"{adAttr.Description}\"."
    else
        printfn $"The description could not be retrieved."
else
    printfn $"The AssemblyDescription attribute is not defined for assembly {assemblyName}."

// Output:
//  The AssemblyDescription attribute is defined for assembly IsDef1FS.
//  The description is "A sample description".

Imports System.Reflection

' Add an AssemblyDescription attribute.
<Assembly: AssemblyDescription("A sample description")> 

Module DemoModule
    Sub Main()
        ' Get the assembly for this module.
        Dim assy As System.Reflection.Assembly = GetType(DemoModule).Assembly
        ' Store the assembly name.
        Dim assyName As String = assy.GetName().Name
        ' See if the AssemblyDescription attribute is defined.
        If Attribute.IsDefined(assy, GetType(AssemblyDescriptionAttribute)) _
            Then
            ' Affirm that the attribute is defined. Assume the filename of
            ' this code example is "IsDef1VB".
            Console.WriteLine("The AssemblyDescription attribute is " & _
                "defined for assembly {0}.", assyName)
            ' Get the description attribute itself.
            Dim attr As Attribute = Attribute.GetCustomAttribute( _
                assy, GetType(AssemblyDescriptionAttribute))
            ' Display the description.
            If Not attr Is Nothing And _
                TypeOf attr Is AssemblyDescriptionAttribute Then
                Dim adAttr As AssemblyDescriptionAttribute = _
                    CType(attr, AssemblyDescriptionAttribute)
                Console.WriteLine("The description is " & _
                    Chr(34) & "{0}" & Chr(34) & ".", adAttr.Description)
            Else
                Console.WriteLine("The description could not be retrieved.")
            End If
        Else
            Console.WriteLine("The AssemblyDescription attribute is not " & _
                              "defined for assembly {0}.", assyName)
        End If
    End Sub
End Module

' Output:
' The AssemblyDescription attribute is defined for assembly IsDef1VB.
' The description is "A sample description".

Комментарии

Замечание

Начиная с версии .NET Framework версии 2.0 этот метод возвращает true, если сборка имеет атрибуты безопасности, хранящиеся в новом формате метаданных. Сборки, скомпилированные с версией 2.0 или более поздней, используют новый формат.

Применяется к

IsDefined(ParameterInfo, Type)

Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs
Исходный код:
Attribute.CoreCLR.cs

Определяет, применяются ли пользовательские атрибуты к параметру метода. Параметры указывают параметр метода и тип настраиваемого атрибута для поиска.

public:
 static bool IsDefined(System::Reflection::ParameterInfo ^ element, Type ^ attributeType);
public static bool IsDefined(System.Reflection.ParameterInfo element, Type attributeType);
static member IsDefined : System.Reflection.ParameterInfo * Type -> bool
Public Shared Function IsDefined (element As ParameterInfo, attributeType As Type) As Boolean

Параметры

element
ParameterInfo

Объект, производный от ParameterInfo класса, описывающего параметр члена класса.

attributeType
Type

Тип или базовый тип настраиваемого атрибута для поиска.

Возвращаемое значение

Boolean

trueЗначение , falseесли настраиваемый атрибут типа attributeType применяется к element; в противном случае .

Исключения

ArgumentNullException

element или attributeType есть null.

ArgumentException

attributeType не является производным от Attribute.

Примеры

В следующем примере кода показано использование IsDefinedпараметра в ParameterInfo качестве параметра.

using System;
using System.Reflection;

namespace IsDef5CS
{
    public class TestClass
    {
        // Assign a ParamArray attribute to the parameter using the keyword.
        public void Method1(params String[] args)
        {}
    }

    public class DemoClass
    {
        static void Main(string[] args)
        {
            // Get the class type to access its metadata.
            Type clsType = typeof(TestClass);
            // Get the MethodInfo object for Method1.
            MethodInfo mInfo = clsType.GetMethod("Method1");
            // Get the ParameterInfo array for the method parameters.
            ParameterInfo[] pInfo = mInfo.GetParameters();
            if (pInfo != null)
            {
                // See if the ParamArray attribute is defined.
                bool isDef = Attribute.IsDefined(pInfo[0],
                                                 typeof(ParamArrayAttribute));
                // Display the result.
                Console.WriteLine("The ParamArray attribute {0} defined for " +
                                  "parameter {1} of method {2}.",
                                  isDef ? "is" : "is not",
                                  pInfo[0].Name,
                                  mInfo.Name);
            }
            else
                Console.WriteLine("The parameters information could " +
                            "not be retrieved for method {0}.", mInfo.Name);
        }
    }
}

/*
 * Output:
 * The ParamArray attribute is defined for parameter args of method Method1.
 */

open System;

type TestClass() =
    // Assign a ParamArray attribute to the parameter.
    member _.Method1([<ParamArray>] args: string[]) = ()

// Get the class type to access its metadata.
let clsType = typeof<TestClass>

// Get the MethodInfo object for Method1.
let mInfo = clsType.GetMethod "Method1"

// Get the ParameterInfo array for the method parameters.
let pInfo = mInfo.GetParameters()

if pInfo <> null then
    // See if the ParamArray attribute is defined.
    let isDef = Attribute.IsDefined(pInfo[0], typeof<ParamArrayAttribute>)

    // Display the result.
    printfn $"""The ParamArray attribute {if isDef then "is" else "is not"} defined for parameter {pInfo[0].Name} of method {mInfo.Name}."""
else
    printfn $"The parameters information could not be retrieved for method {mInfo.Name}."

// Output:
//  The ParamArray attribute is defined for parameter args of method Method1.

Imports System.Reflection

Module DemoModule
    Public Class TestClass
        ' Assign a ParamArray attribute to the parameter using the keyword.
        Public Sub Method1(ByVal ParamArray args As String())
        End Sub
    End Class

    Sub Main()
        ' Get the class type to access its metadata.
        Dim clsType As Type = GetType(TestClass)
        ' Get the MethodInfo object for Method1.
        Dim mInfo As MethodInfo = clsType.GetMethod("Method1")
        ' Get the ParameterInfo array for the method parameters.
        Dim pInfo() As ParameterInfo = mInfo.GetParameters()
        If Not pInfo(0) Is Nothing Then
            ' See if the ParamArray attribute is defined.
            Dim isDef As Boolean = Attribute.IsDefined(pInfo(0), _
                                   GetType(ParamArrayAttribute))
            Dim strDef As String
            If isDef = True Then
                strDef = "is"
            Else
                strDef = "is not"
            End If
            ' Display the result.
            Console.WriteLine("The ParamArray attribute {0} defined " & _
                              "for parameter {1} of method {2}.", _
                              strDef, pInfo(0).Name, mInfo.Name)
        Else
            Console.WriteLine("Could not retrieve parameter information " & _
                              "for method {0}.", mInfo.Name)
        End If
    End Sub
End Module

' Output:
' The ParamArray attribute is defined for parameter args of method Method1.

Комментарии

Предки ищут пользовательские атрибуты element .

Применяется к