PersonalizationDictionary.Add(String, PersonalizationEntry) メソッド

定義

名前空間:
System.Web.UI.WebControls.WebParts
アセンブリ:
System.Web.dll

パーソナル化ディクショナリにパーソナル化エントリを追加します。

public:
 virtual void Add(System::String ^ key, System::Web::UI::WebControls::WebParts::PersonalizationEntry ^ value);
public virtual void Add(string key, System.Web.UI.WebControls.WebParts.PersonalizationEntry value);
abstract member Add : string * System.Web.UI.WebControls.WebParts.PersonalizationEntry -> unit
override this.Add : string * System.Web.UI.WebControls.WebParts.PersonalizationEntry -> unit
Public Overridable Sub Add (key As String, value As PersonalizationEntry)

パラメーター

key
String

状態情報の一意識別子。

value
PersonalizationEntry

パーソナル化ディクショナリに追加する状態情報の一部。 この値は、null の場合もあります。

例外

ArgumentException

key は、ディクショナリに既に存在するキーの複製です。

-又は-

key が空の文字列 ("") であるか、トリミング key 空の文字列になります。

-又は-

value は PersonalizationEntryではありません。

ArgumentNullException

key は nullです。

-又は-

value は nullです。

注釈

このメソッドを呼び出し、さまざまなカスタム状態情報を状態オブジェクトに配置し、状態値に関連付けられているスコープを指定できます。 WebPartManager コントロールがSharedスコープ内にある場合は、SharedスコープまたはUserスコープに関連付けられている名前と状態の情報を追加できます。 Userスコープでは、スコープにのみ関連付けられている名前と状態の情報User追加できます。

ただし、ページのスコープに関係なく、SaveまたはUserスコープを持つプロパティを含むSharedを使用して、すべてのプロパティをディクショナリに追加することをお勧めします。

.NET Framework では、必要に応じて Shared スコープを持つプロパティのみが保存されます。 つまり、最初にWebPartスコープに追加されたShared コントロールが後でページがスコープ内にある間に保存された場合、共有プロパティUser保存されません。 逆のシナリオでは、 WebPart コントロールが User スコープ内のページに追加され、ページが Shared スコープ内にあるときにコントロールが後で保存された場合、カスタム共有プロパティの値が (カスタム ユーザー スコープのプロパティと共に) 保存されます。 個人用設定データの詳細、およびページの個人用設定スコープによる共有プロパティとユーザー スコーププロパティの影響については、「 Web パーツのパーソナル化の概要 」トピックを参照してください。

他のコレクションと同様に、このメソッドはコレクション数を 1 ずつインクリメントし、コレクションで現在アクティブになっている列挙子を無効にする必要があります。

適用対象

こちらもご覧ください