属性の概要 (Visual Basic)

  • [アーティクル]

属性は、メタデータまたは宣言型の情報を、コード (アセンブリ、型、メソッド、プロパティなど) に関連付けるための優れた方法です。 属性をプログラム要素に関連付けると、リフレクションと呼ばれる手法を使用して、実行時にその属性を照会することができます。 詳細については、「リフレクション (Visual Basic)」を参照してください。

属性には、次の特徴があります。

  • 属性は、プログラムにメタデータを追加します。 メタデータは、プログラムで定義された型に関する情報です。 すべての .NET アセンブリには、アセンブリで定義された型および型のメンバーを記述する、指定されたメタデータのセットが含まれます。 カスタム属性を追加して、必要な追加情報を指定することができます。 詳細については、「カスタム属性の作成 (Visual Basic)」を参照してください。

  • 属性は、アセンブリ全体、モジュール、またはクラスやプロパティなどのより小さいプログラム要素に 1 つ以上適用することができます。

  • 属性は、メソッドやプロパティと同じ方法で引数を受け取ることができます。

  • リフレクションを使用して、プログラム自身のメタデータや他のプログラムのメタデータを調べることができます。 詳細については、「リフレクションを使用した属性へのアクセス (Visual Basic)」を参照してください。

属性の使用

属性は、ほぼすべての宣言に配置できますが、属性によっては、有効な宣言の型が制限されている場合もあります。 Visual Basic では、属性は山かっこ (<>) で囲みます。 同じ行の、適用先の要素の直前に追加する必要があります。

この例では、SerializableAttribute 属性を使用してクラスに特性を適用します。

<System.Serializable()> Public Class SampleClass
    ' Objects of this type can be serialized.
End Class

属性 DllImportAttribute を持つメソッドは次のように宣言されます。

Imports System.Runtime.InteropServices

<System.Runtime.InteropServices.DllImport("user32.dll")>
Sub SampleMethod()
End Sub

宣言には、複数の属性を配置できます。

Imports System.Runtime.InteropServices

Sub MethodA(<[In](), Out()> ByVal x As Double)
End Sub
Sub MethodB(<Out(), [In]()> ByVal x As Double)
End Sub

特定のエンティティで複数回指定できる属性もあります。 このような複数回指定できる属性の例として ConditionalAttribute があります。

<Conditional("DEBUG"), Conditional("TEST1")>
Sub TraceMethod()
End Sub

注意

慣例により、属性名はすべて "Attribute" という単語で終わります。これは、.NET Framework の他の項目と区別するためです。 ただし、コード内で属性を使用する場合は、attribute サフィックスを指定する必要はありません。 たとえば、[DllImport] は [DllImportAttribute] と同等ですが、.NET Framework では DllImportAttribute は属性の実際の名前を表します。

属性のパラメーター

属性の多くは、位置指定パラメーター、名前のないパラメーター、または名前付きパラメーターを持っています。 位置指定パラメーターは、特定の順序で指定する必要があり、省略できません。名前付きパラメーターは省略可能で、任意の順序で指定することができます。 位置指定パラメーターは、最初に指定します。 たとえば、次の 3 つの属性は同等です。

<DllImport("user32.dll")>
<DllImport("user32.dll", SetLastError:=False, ExactSpelling:=False)>
<DllImport("user32.dll", ExactSpelling:=False, SetLastError:=False)>

最初のパラメーターである DLL 名は位置指定パラメーターであり、常に最初に指定されます。他のパラメーターは名前付きパラメーターです。 この例の場合、名前付きパラメーターの既定値はどちらも false なので、省略することができます。 パラメーターの既定値については、個々の属性のドキュメントを参照してください。

属性の対象

属性の対象は、属性が適用されるエンティティです。 たとえば、属性は、クラス、特定のメソッド、またはアセンブリ全体に適用できます。 既定では、属性は後に続く要素に適用されます。 ただし、明示的に指定すれば、メソッド、属性のパラメーター、属性の戻り値などにも適用できます。

属性の対象を明示的に識別するには、次の構文を使用します。

<target : attribute-list>

次の表に、使用可能な target の値を示します。

対象の値 対象
assembly アセンブリ全体
module 現在のアセンブリ モジュール (Visual Basic のモジュールとは異なります)

次の例では、アセンブリとモジュールに属性を適用する方法を示します。 詳細については、「共通の属性 (Visual Basic)」を参照してください。

Imports System.Reflection
<Assembly: AssemblyTitleAttribute("Production assembly 4"),
Module: CLSCompliant(True)>

属性の一般的な使用法

次の表に、コードでの属性の一般的な使用法をいくつか示します。

  • Web サービスの WebMethod 属性を使用してメソッドをマークして、メソッドが SOAP プロトコルを介して呼び出されるようにします。 詳細については、「WebMethodAttribute」を参照してください。

  • ネイティブ コードと相互運用するときにメソッドのパラメーターをマーシャリングする方法を記述します。 詳細については、「MarshalAsAttribute」を参照してください。

  • クラス、メソッド、およびインターフェイスの COM プロパティを記述します。

  • DllImportAttribute クラスを使用してアンマネージ コードを呼び出します。

  • タイトル、バージョン、説明、または商標についてのアセンブリを記述します。

  • 永続化のためにシリアル化するクラスのメンバーを記述します。

  • XML シリアル化のためにクラス メンバーと XML ノード間をマップする方法を記述します。

  • メソッドのセキュリティ要件を記述します。

  • セキュリティを適用するための特性を指定します。

  • コードを容易にデバッグできる状態に保つために、ジャスト イン タイム (JIT) コンパイラによって最適化を制御します。

  • メソッドの呼び出し元に関する情報を取得します。

詳細については次を参照してください:

関連項目