Page.RegisterRequiresControlState(Control) Methode

Referenz

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Registriert ein Steuerelement als Steuerelement, dessen Steuerelementzustand beibehalten werden muss.

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)

Parameter

control: Control

Das zu registrierende Steuerelement.

Ausnahmen

ArgumentException

Das zu registrierende Steuerelement ist null.

InvalidOperationException

Die RegisterRequiresControlState(Control)-Methode kann nur vor oder während des PreRender-Ereignisses aufgerufen werden.

Beispiele

Das folgende Codebeispiel zeigt ein benutzerdefiniertes Serversteuerelement, das die RegisterRequiresControlState -Methode aufruft.

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

Hinweise

Benutzerdefinierte Serversteuerelemente, die den Steuerungszustand verwenden, müssen die -Methode für jede Anforderung aufrufen, da die RegisterRequiresControlState Registrierung für den Steuerungszustand während eines Postbackereignisses nicht von Anforderung zu Anforderung übertragen wird. Es wird empfohlen, die Registrierung im Init Ereignis durchzuführen.

Gilt für:

Weitere Informationen

RequiresControlState(Control)