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

定義

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

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 の場合もあります。

例外

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

- または -

key が空の文字列 ("") か、または key をトリムして空の文字列になったかのいずれかです。

- または -

valuePersonalizationEntry ではありません。

keynullです。

または

valuenull です。

注釈

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

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

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

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

適用対象

こちらもご覧ください