AttributeUsageAttribute

.NET Framework クラス ライブラリ リファレンス

AttributeUsageAttribute クラス

別の属性クラスの使用方法を指定します。このクラスは継承できません。

名前空間: System
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

<SerializableAttribute> _
<ComVisibleAttribute(True)> _
<AttributeUsageAttribute(AttributeTargets.Class, Inherited:=True)> _
Public NotInheritable Class
 AttributeUsageAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As AttributeUsageAttribute

C#

[SerializableAttribute] 
[ComVisibleAttribute(true)] 
[AttributeUsageAttribute(AttributeTargets.Class, Inherited=true)]
 
public sealed class AttributeUsageAttribute
 : Attribute

C++

[SerializableAttribute] 
[ComVisibleAttribute(true)] 
[AttributeUsageAttribute(AttributeTargets::Class, Inherited=true)]
 
public ref class AttributeUsageAttribute sealed
 : public Attribute

J#

/** @attribute SerializableAttribute() */ 
/** @attribute ComVisibleAttribute(true) */ 
/** @attribute AttributeUsageAttribute(AttributeTargets.Class, Inherited=true)
 */ 
public final class AttributeUsageAttribute
 extends Attribute

JScript

SerializableAttribute 
ComVisibleAttribute(true) 
AttributeUsageAttribute(AttributeTargets.Class, Inherited=true)
 
public final class AttributeUsageAttribute
 extends Attribute

解説

独自の属性クラスを定義している場合、その属性クラスに AttributeUsageAttribute を配置することによって、そのクラスの使用方法を制御できます。制御対象とする属性クラスは、Attribute から直接または間接に派生したものである必要があります。

属性クラスには、位置指定パラメータと名前付きパラメータがあります。属性クラスの各パブリック コンストラクタは、そのクラスの位置指定パラメータについて、有効なシーケンスを定義します。名前付きパラメータは、属性クラスの非静的で、パブリックで、読み取り/書き込み可能なフィールドまたはプロパティで定義されます。

AttributeUsageAttribute の 3 つのプロパティは、次のパラメータを定義することによって設定します。

• ValidOn

この位置指定パラメータは、制御対象とする属性を配置できるプログラム要素を指定します。属性を配置できるすべての要素は、AttributeTargets 列挙子でリストされます。ビット単位の OR 演算を使用して複数の AttributeTargets 値を組み合わせて、有効なプログラム要素を適宜組み合わせて取得できます。

• AllowMultiple

この名前付きパラメータは、制御対象とする属性を特定のプログラム要素に対して複数回指定できるかどうかを指定します。

• Inherited

この名前付きパラメータは、派生クラスおよびオーバーライドするメンバが、制御対象とする属性を継承できるかどうかを指定します。

属性の使用方法については、Attribute のトピックおよび「属性を使用したメタデータの拡張」を参照してください。

継承階層

System.Object
   System.Attribute
    System.AttributeUsageAttribute

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
AttributeUsageAttribute メンバ
System 名前空間
Attribute クラス
AttributeTargets 列挙体
その他の技術情報
属性を使用したメタデータの拡張

AttributeUsageAttribute コンストラクタ

AttributeTargets、AllowMultiple 値、および Inherited 値の指定リストを使用して、AttributeUsageAttribute クラスの新しいインスタンスを初期化します。

名前空間: System
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    validOn As AttributeTargets _
)

Visual Basic (使用法)

Dim validOn As AttributeTargets

Dim instance As New AttributeUsageAttribute(validOn)

C#

public AttributeUsageAttribute (
    AttributeTargets validOn
)

C++

public:
AttributeUsageAttribute (
    AttributeTargets validOn
)

J#

public AttributeUsageAttribute (
    AttributeTargets validOn
)

JScript

public function AttributeUsageAttribute (
    validOn : AttributeTargets
)

パラメータ

validOn

有効なプログラム要素を示す、ビット単位の OR 演算を使用して組み合わせた値のセット。

解説

ビット単位の OR 演算を使用して複数の AttributeTargets 値を組み合わせて、有効なプログラム要素を適宜組み合わせて取得できます。

既定のプロパティ値については、ValidOn、AllowMultiple、Inherited の各プロパティのトピックを参照してください。

使用例

DispId 属性の定義には、複数の AttributeTargets 値を組み合わせるビット単位の OR 演算の使用方法が示されています。

Visual Basic

Namespace System.Runtime.InteropServices
    
    <AttributeUsage(AttributeTargets.Method _
        Or AttributeTargets.Field _
        Or AttributeTargets.Property)> _    
    Public Class DispIdAttribute    
        Inherits System.Attribute
        
        Public Sub New(value
 As Integer)
            ' . . .
        End Sub
        
        Public ReadOnly Property
 Value() As Integer
            Get
                ' . . .
                Return 0
            End Get
        End Property
    End Class
End Namespace

C#

namespace System.Runtime.InteropServices
{
   [AttributeUsage(AttributeTargets.Method | AttributeTargets.Field |
    AttributeTargets.Property)]
   public class DispIdAttribute: System.Attribute
   {
      public DispIdAttribute(int value) {
        // . . .
      }
      
      public int Value {
         get {
            // . . .
            return 0;
         }
      }
   }
}

C++

namespace InteropServices
{
   [AttributeUsage(AttributeTargets::Method|
   AttributeTargets::Field|
   AttributeTargets::Property)
   ]
   public ref class DispIdAttribute: public
 Attribute
   {
   public:
      DispIdAttribute( int value )
      {
         // . . .
      }

      property int Value 
      {
         int get()
         {
            // . . .
            return 0;
         }
      }
   };
}

J#

/** @attribute AttributeUsage(AttributeTargets.Method | AttributeTargets.Field |
 
    AttributeTargets.Property)
 */
public class DispIdAttribute extends System.Attribute
{    
    public DispIdAttribute(int value)
    {
        //. . .
    } //DispIdAttribute 

    /** @property 
     */
    public int get_Value()
    {
        //. . .
        return 0;
    }//get_Value
} //DispIdAttribute

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
AttributeUsageAttribute クラス
AttributeUsageAttribute メンバ
System 名前空間
AttributeTargets 列挙体

AttributeUsageAttribute プロパティ

パブリック プロパティ

	名前	説明
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)
	ValidOn	制御対象とする属性を適用できるプログラム要素を識別する一連の値を取得します。

参照

関連項目

AttributeUsageAttribute クラス
System 名前空間
Attribute クラス
AttributeTargets 列挙体

その他の技術情報

属性を使用したメタデータの拡張

AttributeUsageAttribute メソッド

パブリック メソッド

	名前	説明
	Equals	オーバーロードされます。 ( Attribute から継承されます。)
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。)
	GetHashCode	このインスタンスのハッシュ コードを返します。 ( Attribute から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 ( Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

参照

関連項目

AttributeUsageAttribute クラス
System 名前空間
Attribute クラス
AttributeTargets 列挙体

その他の技術情報

属性を使用したメタデータの拡張

AttributeUsageAttribute メンバ

別の属性クラスの使用方法を指定します。このクラスは継承できません。

AttributeUsageAttribute データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	AttributeUsageAttribute	AttributeTargets、AllowMultiple 値、および Inherited 値の指定リストを使用して、AttributeUsageAttribute クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)
	ValidOn	制御対象とする属性を適用できるプログラム要素を識別する一連の値を取得します。

パブリック メソッド

	名前	説明
	Equals	オーバーロードされます。 ( Attribute から継承されます。)
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。)
	GetHashCode	このインスタンスのハッシュ コードを返します。 (Attribute から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 (Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 (Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

参照

関連項目

AttributeUsageAttribute クラス
System 名前空間
Attribute クラス
AttributeTargets 列挙体

その他の技術情報

属性を使用したメタデータの拡張