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

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

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

Page.RegisterRequiresControlState メソッド

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

特定のコントロールを、コントロールの状態を維持する必要があるコントロールとして登録します。

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

Visual Basic (宣言)

Public Sub RegisterRequiresControlState ( _
    control As Control _
)

Visual Basic (使用法)

Dim instance As Page
Dim control As Control

instance.RegisterRequiresControlState(control)

public void RegisterRequiresControlState (
    Control control
)

C++

public:
void RegisterRequiresControlState (
    Control^ control
)

public void RegisterRequiresControlState (
    Control control
)

JScript

public function RegisterRequiresControlState
 (
    control : Control
)

パラメータ

control: 登録するコントロール。

例外

例外の種類	条件
ArgumentException	登録するコントロールが null 参照 (Visual Basic では Nothing) です。

解説

コントロールの状態を使用するカスタムサーバーコントロールは、要求のたびに RegisterRequiresControlState メソッドを呼び出す必要があります。これは、コントロールの状態についての登録が、ポストバックイベントの要求間で失われるためです。Init イベントで登録することをお勧めします。

使用例

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