CatalogZoneBase.SaveControlState Method ()


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Saves any changes in a CatalogZoneBase control's state that occur after the Web page is posted back to the server.

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

protected internal override object SaveControlState()

Return Value

Type: System.Object

An Object that contains the state data for the control. If there have been no changes to the state, the method returns null.

The SaveControlState method is concerned with state data that is essential for a control's operation (such as an index or keyword) and is separate from the control's view-state data.

The method first calls the base method to save the existing state data for the control. Next, it determines whether a CatalogPart control in the zone is currently selected, by checking whether the SelectedCatalogPartID property has a value. If there is a selected control, the method updates the existing state data with the state data from the selected control, and then returns all the state data.

Notes to Inheritors:

You can optionally override the SaveControlState method in a derived class so that you can update the saved control state for other custom objects in the zone.

.NET Framework
Available since 2.0
Return to top