SettingsBase.Item プロパティ

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

SettingsBase.Item プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

指定した設定プロパティの値を取得または設定します。

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

Visual Basic (宣言)

Public Overridable Default
 Property Item ( _
    propertyName As String _
) As Object

Visual Basic (使用法)

Dim instance As SettingsBase
Dim propertyName As String
Dim value As Object

value = instance(propertyName)

instance(propertyName) = value

C#

public virtual Object this [
    string propertyName
] { get; set; }

C++

public:
virtual property Object^ default [String^] {
    Object^ get (String^ propertyName);
    void set (String^ propertyName, Object^
 value);
}

J#

/** @property */
public Object get_Item (String propertyName)

/** @property */
public void set_Item (String propertyName,
 Object value)

JScript

JScript では、インデックス付きのプロパティは使用できますが、新規に宣言することはできません。.

パラメータ

propertyName

アクセスするプロパティの名前を格納している String。

プロパティ値
存在する場合は、名前付き設定プロパティの値。

例外

例外の種類	条件
SettingsPropertyNotFoundException	現在のオブジェクトに関連付けられたプロパティが存在しないか、指定したプロパティが見つかりませんでした。
SettingsPropertyIsReadOnlyException	読み取り専用プロパティを設定しようとしました。
SettingsPropertyWrongTypeException	設定操作で指定された値が、設定プロパティとは互換性のない型です。

解説

インデクサとも呼ばれる Item プロパティは、通常、SettingsBase から派生する設定クラスで使用されます。Item プロパティで、クラスのパブリック プロパティが、対応する設定プロパティに関連付けられます。

プロパティが最初にアクセスされたとき、SettingsBase インスタンスは、同じプロバイダを共有する他のすべてのプロパティを、要求されたプロパティとして検索します。SettingsBase インスタンスは、次にプロバイダを呼び出し、プロバイダが取得する必要のあるデータを表す SettingsProperty オブジェクトのセットを渡します。

IsSynchronized が true の場合、インデクサは、スレッドセーフな方法でプロパティ データの取得および設定を行います。既定では、SettingsBase インスタンスはスレッドセーフではありません。ただし、Synchronized を呼び出し、SettingsBase インスタンスに渡して、SettingsBase インデクサをスレッドセーフな方法で動作させることができます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
SettingsBase クラス
SettingsBase メンバ
System.Configuration 名前空間
IsReadOnly