This documentation is archived and is not being maintained.

UserControl.SaveViewState Method

Saves any user control view-state changes that have occurred since the last page postback.

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)

protected override Object SaveViewState()

Return Value

Type: System.Object
Returns the user control's current view state. If there is no view state associated with the control, it returns null.

In general, you do not need to call this method. However, if you store custom information in view state, you can override this method to do so.

The following example demonstrates a user control that manages its view state using the LoadViewState and SaveViewState methods.


   public string UserText
   {
	   get
	   {
		   return (string)ViewState["usertext"];
	   }
	   set
	   {
		   ViewState["usertext"] = value;
	   }
   }
   public string PasswordText
   {
	   get
	   {
		   return (string)ViewState["passwordtext"];
	   }
	   set
	   {
		   ViewState["passwordtext"] = value;
	   }
   }

   [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")] 
   protected override void LoadViewState(object savedState) 
   {
	   object[] totalState = null;	   
	   if (savedState != null)
	   {
		   totalState = (object[])savedState;
		   if (totalState.Length != 3)
		   {
			   // Throw an appropriate exception.
		   }
		   // Load base state.
		   base.LoadViewState(totalState[0]);
		   // Load extra information specific to this control.
		   if (totalState != null && totalState[1] != null && totalState[2] != null)
		   {
			   UserText = (string)totalState[1];
			   PasswordText = (string)totalState[2];
		   }
	   }

   }

   [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")] 
   protected override object SaveViewState()
   {
	   object baseState = base.SaveViewState();
	   object[] totalState = new object[3];
	   totalState[0] = baseState;
	   totalState[1] = user.Text;
	   totalState[2] = password.Text;
	   return totalState;
   }


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: