プロパティ (C++ コンポーネント拡張)

[アーティクル]
02/21/2013

プロパティを宣言します。プロパティとは、データメンバーや配列要素と同様に機能し、アクセスできるメンバー関数です。

All Runtimes

次のいずれかの種類のプロパティを宣言できます。

シンプルプロパティ
既定では、プロパティ値を割り当てる set アクセサー、プロパティ値を取得する get アクセサー、およびプロパティ値を含むプライベートデータメンバー (コンパイラにより生成) を作成します。
プロパティブロック
これを使用して、ユーザー定義の get アクセサーまたは set アクセサーを作成します。get アクセサーおよび set アクセサーの両方が定義されている場合、プロパティの読み取りと書き込みを実行できます。get アクセサーのみが定義されている場合、プロパティは読み取り専用です。set アクセサーのみが定義されている場合、プロパティは書き込み専用です。

プロパティ値を格納するデータメンバーを明示的に宣言する必要があります。
インデックスプロパティ
1 つ以上のインデックスで指定されるプロパティの値を取得および設定するために使用できるプロパティブロック。

ユーザー定義のプロパティ名または既定のプロパティ名を持つインデックスプロパティを作成できます。既定のインデックスプロパティの名前は、プロパティが定義されているクラスの名前です。既定のプロパティを宣言するには、プロパティ名ではなく default キーワードを指定します。

You must explicitly declare a data member to contain the property value.通常、インデックスプロパティの場合、データメンバーは配列またはコレクションになります。

Syntax

   property type property_name;

   property type property_name {
      access-modifier type get() inheritance-modifier {property_body};
      access-modifier void set(type value) inheritance-modifier {property_body};
   }

   property type property_name[index_list] {
      access-modifier type get(index_list) inheritance-modifier {property_body};
      access-modifier void set(index_list, value) inheritance-modifier {property_body};
   }

   property type default[index_list] {
      access-modifier type get(index_list) inheritance-modifier {property_body};
      access-modifier void set(index_list, value) inheritance-modifier {property_body};
   }

Parameters

type
プロパティ値のデータ型、つまりプロパティ自体です。
property_name
プロパティの名前。
access-modifier
アクセス修飾子。有効な修飾子は static および virtual です。

get アクセサーまたは set アクセサーの virtual 修飾子が一致する必要はありませんが、static 修飾子は一致する必要があります。
inheritance-modifier
継承修飾子。有効な修飾子は abstract および sealed です。
index_list
1 つ以上のインデックスのコンマ区切りのリスト。各インデックスは、インデックスの型と、プロパティメソッドの本文で使用できる識別子 (省略可能) で構成されます。
value
set 操作でプロパティに代入される値、または get 操作で取得される値。
property_body
set アクセサーまたは get アクセサーのプロパティメソッドの本体。property_body では index_list を、基になるプロパティデータメンバーにアクセスするために使用するか、ユーザー定義処理のパラメーターとして使用できます。

Windows ランタイム

詳細については、「プロパティ (C++/CX)」を参照してください。

要件

Compiler option: /ZW

共通言語ランタイム

Syntax

modifier property type property_name;

modifier property type property_name {
   modifier void set(type);
   modifier type get();
}
modifier property type property_name[index-list, value] {
   modifier void set(index-list, value);
   modifier type get(index-list);

modifier property type default[index];
}

Parameters

modifier
プロパティの宣言または get/set アクセサーメソッドで使用できる修飾子。使用可能な値は static と virtual です。
type
プロパティで表される値の型。
property_name
raise メソッドのパラメーター。デリゲートのシグネチャと一致する必要があります。
index_list
1 つ以上のインデックスのリスト (コンマ区切り)。角かっこ (添字演算子 []) で囲んで指定します。各インデックスについて型を指定し、さらに必要に応じてプロパティメソッドの本文で使用できる識別子も指定します。

解説

最初の構文サンプルでは、シンプルプロパティを示しています。ここでは set メソッドと get メソッドの両方を暗黙的に宣言しています。コンパイラは自動的にプロパティの値を格納するためのプライベートフィールドを作成します。

2 つ目の構文サンプルでは、プロパティブロックを示しています。ここでは set メソッドと get メソッドの両方を明示的に宣言しています。

3 つ目の構文サンプルでは、ユーザー定義のインデックスプロパティを示しています。インデックスプロパティは、設定または取得する値だけでなくパラメーターも受け取ります。プロパティに名前を指定する必要があります。シンプルプロパティとは異なり、インデックスプロパティの set メソッドと get メソッドは明示的に定義する必要があり、さらにプロパティの名前も指定する必要があります。

4 つ目の構文サンプルでは、型のインスタンスに対して配列と同様にアクセスできるようにする、既定のプロパティを示しています。default キーワードは、既定のプロパティを指定する場合にのみ使用されます。既定のプロパティの名前は、プロパティが定義されている型の名前です。

property キーワードは、クラス、インターフェイス、または値の型で使用できます。プロパティには get 関数 (読み取り専用)、set 関数 (書き込み専用)、またはその両方 (読み取り/書き込み) を定義できます。

プロパティ名は、それ自身が含まれるマネージクラスの名前と同じにすることはできません。getter 関数の戻り値の型は、対応する setter 関数の最後のパラメーターの型と一致する必要があります。

クライアントコードに対しては、プロパティは通常のデータメンバーと同じように扱うことができ、データメンバーと同じ構文を使用して書き込みまたは読み取りを実行できます。

get メソッドと set メソッドの virtual 修飾子が一致する必要はありません。

get メソッドと set メソッドのアクセシビリティが異なっていても問題ありません。

プロパティメソッドは、通常のメソッドと同様に、クラスの本文の外でも定義できます。

プロパティの get メソッドと set メソッドの static 修飾子は一致していても問題ありません。

プロパティの get メソッドと set メソッドが次の説明に適合している場合、そのプロパティはスカラーです。

get メソッドにはパラメーターがなく、戻り値の型は T です。
set メソッドには T 型のパラメーターがあり、戻り値の型は void です。

同じ ID のスコープ内では、1 つのスカラープロパティしか宣言できません。スカラープロパティはオーバーロードできません。

プロパティデータメンバーを宣言すると、コンパイラはクラスにデータメンバーを挿入します。このデータメンバーは "バッキングストア" とも呼ばれます。ただし、このデータメンバーの名前は、外側のクラスの実際のデータメンバーであるかのように、ソース内のメンバーを参照できないような形式になっています。型のメタデータを表示し、プロパティのバッキングストアに対してコンパイラが生成した名前を確認するには、ildasm.exe を使用します。

プロパティブロック内のアクセサーメソッドについては、異なるアクセシビリティが許容されます。つまり、set メソッドをパブリックに、get メソッドをプライベートにすることができます。ただし、アクセサーメソッドのアクセシビリティが、プロパティ自体の宣言でのアクセシビリティよりも制限が少ない場合、エラーになります。

property は状況依存のキーワードです。詳細については、「状況依存のキーワード (C++ コンポーネント拡張)」を参照してください。

プロパティの詳細については、次を参照してください。

要件

Compiler option: /clr

例

次の例は、プロパティのデータメンバーとプロパティブロックの宣言方法と使用方法を示しています。これにより、プロパティアクセサーがクラスから定義できることもわかります。

// mcppv2_property.cpp
// compile with: /clr
using namespace System;
public ref class C {
   int MyInt;
public:

   // property data member
   property String ^ Simple_Property;

   // property block
   property int Property_Block {

      int get();

      void set(int value) {
         MyInt = value;
      }
   }
};

int C::Property_Block::get() {
   return MyInt;
}

int main() {
   C ^ MyC = gcnew C();
   MyC->Simple_Property = "test";
   Console::WriteLine(MyC->Simple_Property);

   MyC->Property_Block = 21;
   Console::WriteLine(MyC->Property_Block);
}

出力

参照

概念

ランタイムプラットフォームのコンポーネントの拡張機能

次の方法で共有