AttributeTargets Enumeration
.NET Framework Class Library
AttributeTargets Enumeration

Specifies the application elements on which it is valid to apply an attribute.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
Visual Basic (Declaration)
<SerializableAttribute> _
<FlagsAttribute> _
<ComVisibleAttribute(True)> _
Public Enumeration AttributeTargets
Visual Basic (Usage)
Dim instance As AttributeTargets
C#
[SerializableAttribute]
[FlagsAttribute]
[ComVisibleAttribute(true)]
public enum AttributeTargets
Visual C++
[SerializableAttribute]
[FlagsAttribute]
[ComVisibleAttribute(true)]
public enum class AttributeTargets
JScript
public enum AttributeTargets
Member nameDescription
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkAssemblyAttribute can be applied to an assembly.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkModuleAttribute can be applied to a module.
NoteNote:
Module refers to a portable executable file (.dll or.exe) and not a Visual Basic standard module.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkClassAttribute can be applied to a class.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkStructAttribute can be applied to a structure; that is, a value type.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkEnumAttribute can be applied to an enumeration.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkConstructorAttribute can be applied to a constructor.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkMethodAttribute can be applied to a method.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkPropertyAttribute can be applied to a property.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkFieldAttribute can be applied to a field.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkEventAttribute can be applied to an event.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkInterfaceAttribute can be applied to an interface.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkParameterAttribute can be applied to a parameter.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkDelegateAttribute can be applied to a delegate.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkReturnValueAttribute can be applied to a return value.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkGenericParameterAttribute can be applied to a generic parameter.
Supported by the .NET Compact FrameworkSupported by the XNA FrameworkAllAttribute can be applied to any application element.

The AttributeUsageAttribute class uses this enumeration to specify the kind of element on which it is valid to apply an attribute.

AttributeTargets enumeration values can be combined with a bitwise OR operation to get the preferred combination.

The following code sample illustrates the application of the AttributeTargets enumeration:

Visual Basic
Imports System

Module DemoModule
    ' This attribute is only valid on a class.
    <AttributeUsage(AttributeTargets.Class)> _
    Public Class ClassTargetAttribute
        Inherits Attribute
    End Class

    ' This attribute is only valid on a method.
    <AttributeUsage(AttributeTargets.Method)> _
    Public Class MethodTargetAttribute
        Inherits Attribute
    End Class

    ' This attribute is only valid on a constructor.
    <AttributeUsage(AttributeTargets.Constructor)> _
    Public Class ConstructorTargetAttribute 
        Inherits Attribute
    End Class

    ' This attribute is only valid on a field.
    <AttributeUsage(AttributeTargets.Field)> _
    Public Class FieldTargetAttribute 
        Inherits Attribute
    End Class

    ' This attribute is valid on a class or a method.
    <AttributeUsage(AttributeTargets.Class Or AttributeTargets.Method)> _
    Public Class ClassMethodTargetAttribute 
        Inherits Attribute
    End Class

    ' This attribute is valid on any target.
    <AttributeUsage(AttributeTargets.All)> _
    Public Class AllTargetsAttribute 
        Inherits Attribute
    End Class

    <ClassTarget, _
    ClassMethodTarget, _
    AllTargets> _
    Public Class TestClassAttribute
        <ConstructorTarget, _
        AllTargets> _
        Public Sub New
        End Sub

        <MethodTarget, _
        ClassMethodTarget, _
        AllTargets> _
        Public Sub Method1()
        End Sub

        <FieldTarget, _
        AllTargets> _
        Public myInt as Integer
    End Class

    Sub Main()
    End Sub
End Module
C#
using System;

namespace AttTargsCS {
    // This attribute is only valid on a class.
    [AttributeUsage(AttributeTargets.Class)]
    public class ClassTargetAttribute : Attribute {
    }

    // This attribute is only valid on a method.
    [AttributeUsage(AttributeTargets.Method)]
    public class MethodTargetAttribute : Attribute {
    }

    // This attribute is only valid on a constructor.
    [AttributeUsage(AttributeTargets.Constructor)]
    public class ConstructorTargetAttribute : Attribute {
    }

    // This attribute is only valid on a field.
    [AttributeUsage(AttributeTargets.Field)]
    public class FieldTargetAttribute : Attribute {
    }

    // This attribute is valid on a class or a method.
    [AttributeUsage(AttributeTargets.Class|AttributeTargets.Method)]
    public class ClassMethodTargetAttribute : Attribute {
    }

    // This attribute is valid on any target.
    [AttributeUsage(AttributeTargets.All)]
    public class AllTargetsAttribute : Attribute {
    }

    [ClassTarget]
    [ClassMethodTarget]
    [AllTargets]
    public class TestClassAttribute {
        [ConstructorTarget]
        [AllTargets]
        TestClassAttribute() {
        }

        [MethodTarget]
        [ClassMethodTarget]
        [AllTargets]
        public void Method1() {
        }

        [FieldTarget]
        [AllTargets]
        public int myInt;

        static void Main(string[] args) {
        }
    }
}
Visual C++
using namespace System;

namespace AttTargsCS
{

   // This attribute is only valid on a class.

   [AttributeUsage(AttributeTargets::Class)]
   public ref class ClassTargetAttribute: public Attribute{};


   // This attribute is only valid on a method.

   [AttributeUsage(AttributeTargets::Method)]
   public ref class MethodTargetAttribute: public Attribute{};


   // This attribute is only valid on a constructor.

   [AttributeUsage(AttributeTargets::Constructor)]
   public ref class ConstructorTargetAttribute: public Attribute{};


   // This attribute is only valid on a field.

   [AttributeUsage(AttributeTargets::Field)]
   public ref class FieldTargetAttribute: public Attribute{};


   // This attribute is valid on a class or a method.

   [AttributeUsage(AttributeTargets::Class|AttributeTargets::Method)]
   public ref class ClassMethodTargetAttribute: public Attribute{};


   // This attribute is valid on any target.

   [AttributeUsage(AttributeTargets::All)]
   public ref class AllTargetsAttribute: public Attribute{};


   [ClassTarget]
   [ClassMethodTarget]
   [AllTargets]
   public ref class TestClassAttribute
   {
   private:

      [ConstructorTarget]
      [AllTargets]
      TestClassAttribute(){}


   public:

      [MethodTarget]
      [ClassMethodTarget]
      [AllTargets]
      void Method1(){}


      [FieldTarget]
      [AllTargets]
      int myInt;
      static void Main(){}

   };

}

JScript
import System;

package AttTargsJS {
    // This attribute is only valid on a class.
    AttributeUsage(AttributeTargets.Class)
    public class ClassTargetAttribute extends Attribute {
    }

    // This attribute is only valid on a method.
    AttributeUsage(AttributeTargets.Method)
    public class MethodTargetAttribute extends Attribute {
    }

    // This attribute is only valid on a constructor.
    AttributeUsage(AttributeTargets.Constructor)
    public class ConstructorTargetAttribute extends Attribute {
    }

    // This attribute is only valid on a field.
    AttributeUsage(AttributeTargets.Field)
    public class FieldTargetAttribute extends Attribute {
    }

    // This attribute is valid on a class or a method.
    AttributeUsage(AttributeTargets.Class|AttributeTargets.Method)
    public class ClassMethodTargetAttribute extends Attribute {
    }

    // This attribute is valid on any target.
    AttributeUsage(AttributeTargets.All)
    public class AllTargetsAttribute extends Attribute {
    }

    ClassTargetAttribute
        ClassMethodTargetAttribute
        AllTargetsAttribute
    public class TestClassAttribute {
        ConstructorTargetAttribute
        AllTargetsAttribute
        function TestClassAttribute() {
        }

        MethodTargetAttribute
                ClassMethodTargetAttribute
                AllTargetsAttribute
        public function Method1() {
        }

        FieldTargetAttribute
                AllTargetsAttribute
        public var myInt : int;

        static function Main(args : String[]) {
        }
    }
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
Page view tracker