Set ステートメント (Visual Basic)

[アーティクル]
08/09/2011

値をプロパティに代入するための Set プロパティプロシージャを宣言します。

[ <attributelist> ] [ accessmodifier ] Set (ByVal value [ As datatype ])
    [ statements ]
End Set

指定項目

attributelist
省略可能です。「属性リスト」を参照してください。
accessmodifier
省略可能です。このプロパティの Get ステートメントか Set ステートメントの一方に指定できます。次のいずれかの値を指定します。
- Protected
- Friend
- Private
- Protected Friend
「Visual Basic でのアクセスレベル」を参照してください。
value
必ず指定します。このパラメーターには、プロパティの新しい値が格納されます。
datatype
Option Strict が On の場合は、必ず指定します。 value パラメーターのデータ型を指定します。指定するデータ型は、この Set ステートメントを宣言するプロパティのデータ型と同じにする必要があります。
statements
省略可能です。 Set プロパティプロシージャの呼び出し時に実行される 1 つ以上のステートメントを指定します。
End Set
必ず指定します。 Set プロパティプロシージャの定義を終了します。

解説

ReadOnly のマークが付けられたプロパティを除き、すべてのプロパティは Set プロパティプロシージャを持つ必要があります。 Set プロシージャは、プロパティの値を設定するために使用されます。

プロパティに保存する値が代入ステートメントで指定された場合、Visual Basic は自動的にプロパティの Set プロシージャを呼び出します。

Visual Basic は、プロパティの割り当ての際に、パラメーターを Set プロシージャに渡します。 Set のパラメーターを指定しないと、統合開発環境 (IDE: Integrated Development Environment) では value というパラメーターが暗黙的に使用されます。このパラメーターには、プロパティに代入する値が含まれています。通常、この値はプライベートなローカル変数に格納しますが、Get プロシージャを呼び出せばいつでも値を取得できます。

プロパティ宣言の本体には、プロパティの Get プロシージャと Set プロシージャのみを Property ステートメントステートメントと End Property ステートメントの間に記述できます。それ以外のプロシージャを含めることはできません。特に、プロパティの現在の値を含めることはできません。現在の値をどちらかのプロパティプロシージャの内部に含めると他のプロパティプロシージャから値にアクセスできなくなるため、この値はプロパティの外部に格納する必要があります。通常は、プロパティと同じレベルで Private (Visual Basic) 変数を宣言し、この中に現在の値を格納します。 Set プロシージャが適用されるプロパティには、このプロシージャを内部に定義する必要があります。

Set ステートメント内で accessmodifier を使ってアクセスレベルを設定しない限り、既定で Set プロシージャのアクセスレベルは、それが含まれるプロパティと同じになります。

規則

アクセスレベルの混在。 読み書き可能なプロパティを定義する場合、必要であれば Get プロシージャと Set プロシージャのどちらか一方にだけ、プロパティとは異なるアクセスレベルを指定できます。これを指定する場合は、プロシージャにプロパティよりも制限の高いアクセスレベルを指定する必要があります。たとえば、プロパティを Friend で宣言する場合、Set プロシージャを Private で宣言できますが、Public では宣言できません。

WriteOnly プロパティを宣言している場合は、Set プロシージャはプロパティ全体を表します。別のアクセスレベルを Set に宣言するとプロパティに 2 つのアクセスレベルを設定することになるので、このような宣言はできません。

動作

プロパティプロシージャからの制御の戻り。 Set プロシージャから呼び出し元のコードに制御が戻るとき、プロパティに格納する値を渡したステートメントの直後から実行が続行されます。

Set プロパティプロシージャは、Return ステートメント (Visual Basic) または Exit ステートメント (Visual Basic) を使って呼び出し元に戻ることができます。

Exit Property ステートメントおよび Return ステートメントは、プロパティプロシージャを直ちに終了します。プロシージャの任意の場所に、Exit Property ステートメントと Return ステートメントを何度でも定義できます。また、Exit Property ステートメントと Return ステートメントを混在して使用できます。

使用例

Set ステートメントを使って、プロパティの値を設定するコード例を次に示します。

Class propClass
    Private propVal As Integer
    Property prop1() As Integer
        Get
            Return propVal
        End Get
        Set(ByVal value As Integer)
            propVal = value
        End Set
    End Property
End Class