Control.SaveControlState メソッドとは何？わかりやすく解説 Weblio辞書

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

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

Control.SaveControlState メソッド

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

ページがサーバーにポストバックされた時間以降に発生した、サーバーコントロールの状態の変更を保存します。

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

Visual Basic (宣言)

Protected Friend Overridable
 Function SaveControlState As Object

Visual Basic (使用法)

Dim returnValue As Object

returnValue = Me.SaveControlState

protected internal virtual Object SaveControlState ()

C++

protected public:
virtual Object^ SaveControlState ()

protected Object SaveControlState ()

JScript

protected internal function
 SaveControlState () : Object

戻り値
サーバーコントロールの現在の状態を返します。コントロールに関連付けられている状態がない場合、このメソッドは null 参照 (Visual Basic では Nothing) を返します。

解説

SaveControlState メソッドを使用して、特定のコントロールの操作に必要な状態情報を保存します。このコントロールの状態データは、コントロールのビューステートデータとは別に保存されます。

コントロールの状態を使用するカスタムコントロールは、コントロールの状態を保存する前に、Page の RegisterRequiresControlState メソッドを呼び出す必要があります。

継承時の注意 コントロールの状態を保存すると、この文字列オブジェクトは HTML HIDDEN 要素に格納された変数としてクライアントに返されます。コントロールで使用する状態情報を抽出するには、このメソッドをオーバーライドします。コントロールの状態としては、ページインデックスやキーワードなど、少量の重要なデータが想定されています。大量のデータにコントロールの状態を使用すると、ページのパフォーマンスに悪い影響を与える可能性があります。詳細については、「ASP.NET の状態管理」を参照してください。

使用例

カスタム ASP.NET コントロールの SaveControlState メソッドをオーバーライドするコード例を次に示します。このメソッドは、呼び出されると、内部プロパティ currentIndex が既定値以外に設定されているかどうかを確認し、既定値以外に設定されている場合、この値をコントロールの状態に保存します。

OnInit メソッドは、Page で RegisterRequiresControlState メソッドを呼び出して、カスタムコントロールでコントロールの状態を使用することを示すためにオーバーライドされます。

Visual Basic

Class Sample
  Inherits Control
  
  Dim currentIndex As Integer
  
  Overloads Sub OnInit(ByVal
 e As EventArgs)
    Page.RegisterRequiresControlState(Me)
    currentIndex = 0
    
    MyBase.OnInit(e)
  End Sub
  
  Overloads Function SaveControlState() As
 Object
    If currentIndex <> 0 Then
      Return CType(currentIndex, Object)
    Else
      Return Nothing
    End If
  End Function
  
  Overloads Sub LoadControlState(ByVal
 state As Object)
    If (state <> Nothing) Then
      currentIndex = CType(state, Integer)
    End If
  End Sub
  
End Class

public class Sample : Control {
    private int currentIndex = 0;
   
    protected override void OnInit(EventArgs
 e) {
        Page.RegisterRequiresControlState(this);
        base.OnInit(e);
    }

    protected override object SaveControlState() {
        return currentIndex != 0 ? (object)currentIndex : null;
    }

    protected override void LoadControlState(object
 state) {
        if (state != null) {
            currentIndex = (int)state;
        }
    }
}