StateBag.Item プロパティとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

StateBag.Item プロパティ

StateBag オブジェクト内に格納された項目の値を取得または設定します。

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

Visual Basic (宣言)

Public Default Property
 Item ( _
    key As String _
) As Object

Visual Basic (使用法)

Dim instance As StateBag
Dim key As String
Dim value As Object

value = instance(key)

instance(key) = value

public Object this [
    string key
] { get; set; }

C++

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

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

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

JScript

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

パラメータ

key: 項目のキー。

プロパティ値
StateBag オブジェクト内の指定した項目。

解説

コントロールまたはページのビューステートの値を保存および取得するには、このメンバを使用するのが最も簡単な方法です。

このプロパティを設定するときに、項目がまだ StateBag オブジェクトに格納されていない場合は、その項目のキーと値のペアがコレクションに追加されます。TrackViewState メソッドが項目に対して呼び出される前に、このプロパティを null 参照 (Visual Basic では Nothing) に設定した場合、その項目は StateBag オブジェクトから削除されます。それ以外の場合は、このプロパティを null 参照 (Visual Basic では Nothing) に設定すると、キーが保存されて項目のビューステートを追跡できるようになります。

使用例

名前と値をキー/値ペアとして Control.ViewState プロパティに保存するプロパティのコード例を次に示します。ViewState プロパティは、StateBag クラスのインスタンスです。

Visual Basic

' Add property values to view state with set; 
' retrieve them from view state with get.
Public Property [Text]() As
 String
    Get
        Dim o As Object
 = ViewState("Text")
        If (IsNothing(o)) Then
            Return String.Empty
        Else
            Return CStr(o)
        End If
    End Get
    Set(ByVal value As String)
        ViewState("Text") = value
    End Set
End Property

private const int defaultFontSize
 = 3;

// Add property values to view state with set;
// retrieve them from view state with get.
public String Text
{
    get 
    { 
        object o = ViewState["text"]; 
        return (o == null)? String.Empty :
 (string)o;
    }

    set
    {
        ViewState["Text"] = value;
    }
}

// Add property values to view state with set;
// retrieve them from view state with get.
/** @property 
 */
public String get_Text()
{
    return ((String)(get_ViewState().get_Item("Text")));
} //get_Text

/** @property 
 */
public void set_Text(String value)
{
    get_ViewState().set_Item("Text", value);
} //set_Text

JScript

// Add property values to view state with set;
// retrieve them from view state with get.
public function get Text()
 : String 
{
       return String(ViewState["Text"]);
}

public function set Text(value
 : String)
{
       ViewState["Text"] = value;
}