PersonalizationDictionary.Add メソッド

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

PersonalizationDictionary.Add メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Overridable Sub Add
 ( _
    key As String, _
    value As PersonalizationEntry _
)

Visual Basic (使用法)

Dim instance As PersonalizationDictionary
Dim key As String
Dim value As PersonalizationEntry

instance.Add(key, value)

C#

public virtual void Add (
    string key,
    PersonalizationEntry value
)

C++

public:
virtual void Add (
    String^ key, 
    PersonalizationEntry^ value
)

J#

public void Add (
    String key, 
    PersonalizationEntry value
)

JScript

public function Add (
    key : String, 
    value : PersonalizationEntry
)

パラメータ

key

特定の状態情報の一意識別子。

value

パーソナル化ディクショナリに追加される特定の状態情報。この値は、null 参照 (Visual Basic では Nothing) の場合もあります。

例外

例外の種類	条件
ArgumentException	key は、既にディクショナリ内に存在するキーの複製です。 または key が空の文字列 ("") か、または key をトリムして空の文字列になったかのいずれかです。 または value が PersonalizationEntry ではありません。
ArgumentNullException	key が null 参照 (Visual Basic では Nothing) です。 または value が null 参照 (Visual Basic では Nothing) です。

解説

このメソッドを使用して、各種のカスタム状態情報を状態オブジェクトに格納し、状態の値に関連付けられているスコープを指定できます。WebPartManager コントロールが Shared スコープ内に存在する場合、Shared スコープまたは User スコープのいずれかに関連付けられている名前情報および状態情報を追加できます。User スコープ内では、User スコープだけに関連付けられている名前情報および状態情報を追加できます。

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

.NET Framework は、適切な場合に Shared スコープが存在するプロパティだけを保存します。つまり、最初は Shared スコープで追加された WebPart コントロールが、その後ページが User スコープ内にある間に保存された場合、共有プロパティは保存されません。逆の状況として、WebPart コントロールが User スコープでページに追加され、その後ページが Shared スコープの間にコントロールが保存された場合、カスタム共有プロパティの値が (カスタムのユーザースコープ プロパティと共に) 保存されます。パーソナル化データの詳細、およびページのパーソナル化スコープが共有プロパティやユーザースコープのプロパティにどのように影響するかについては、Web パーツのパーソナル化の概要 のトピックを参照してください。

他のコレクションと同様に、このメソッドはコレクションの数を 1 インクリメントし、コレクションで現在アクティブな列挙子は無効にされます。

プラットフォーム

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

参照

関連項目
PersonalizationDictionary クラス
PersonalizationDictionary メンバ
System.Web.UI.WebControls.WebParts 名前空間
その他の技術情報
Web パーツのパーソナル化の概要