Page.RegisterRequiresControlState(Control) メソッド

定義

名前空間:
System.Web.UI
アセンブリ:
System.Web.dll

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

public:
 void RegisterRequiresControlState(System::Web::UI::Control ^ control);
public void RegisterRequiresControlState(System.Web.UI.Control control);
member this.RegisterRequiresControlState : System.Web.UI.Control -> unit
Public Sub RegisterRequiresControlState (control As Control)

パラメーター

control
Control

登録するコントロール。

例外

ArgumentException

登録するコントロールが null。

InvalidOperationException

RegisterRequiresControlState(Control) メソッドは、PreRender イベントの前または実行中にのみ呼び出すことができます。

例

次のコード例は、 RegisterRequiresControlState メソッドを呼び出すカスタム サーバー コントロールを示しています。

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

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

注釈

制御状態を使用するカスタム サーバー コントロールでは、ポストバック イベント中に制御状態の登録が要求から要求に引き継がないため、各要求で RegisterRequiresControlState メソッドを呼び出す必要があります。 Init イベントで登録を行うことをお勧めします。

適用対象

こちらもご覧ください