Control.LoadControlState メソッド

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

Control.LoadControlState メソッド

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

SaveControlState メソッドによって保存された前回のページ要求からコントロールの状態情報を復元します。

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

Visual Basic (宣言)

Protected Friend Overridable
 Sub LoadControlState ( _
    savedState As Object _
)

Visual Basic (使用法)

Dim savedState As Object

Me.LoadControlState(savedState)

C#

protected internal virtual void LoadControlState
 (
    Object savedState
)

C++

protected public:
virtual void LoadControlState (
    Object^ savedState
)

J#

protected void LoadControlState (
    Object savedState
)

JScript

protected internal function
 LoadControlState (
    savedState : Object
)

パラメータ

savedState

復元するコントロールの状態を表す Object。

解説

カスタム サーバー コントロールがコントロールの状態を復元する方法を指定する必要がある場合は、このメソッドをオーバーライドします。詳細については、「ASP.NET の状態管理」を参照してください。

使用例

カスタム ASP.NET コントロールの LoadControlState メソッドをオーバーライドするコード例を次に示します。このメソッドは、呼び出されると、このコントロールに関してコントロールの状態が以前に保存されているかどうかを確認し、保存されている場合は、内部プロパティ 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

C#

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;
        }
    }
}

プラットフォーム

Windows 98, Windows 2000 SP4, 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

参照

関連項目
Control クラス
Control メンバ
System.Web.UI 名前空間
SaveControlState
ViewState
SaveViewState
その他の技術情報
ASP.NET ページのライフ サイクルの概要