CatalogZoneBase::CreateCatalogParts Method ()

 
System_CAPS_noteNote

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

Provides a base method declaration that derived zones can override to handle the details of creating the CatalogPart controls contained in a zone.

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

protected:
virtual CatalogPartCollection^ CreateCatalogParts() abstract

Return Value

Type: System.Web.UI.WebControls.WebParts::CatalogPartCollection^

A CatalogPartCollection that contains the collection of CatalogPart controls associated with the zone.

The CreateCatalogParts method provides no implementation. It is intended to be implemented in a derived class, and should be used to create an instance of the collection of CatalogPart controls contained in a zone, whenever the hosting Web page enters catalog mode. The CatalogZone::CreateCatalogParts method provides one example of an implementation of the CreateCatalogParts method.

System_CAPS_noteNote

Note that any CatalogPart that is added to the collection of CatalogPart controls in an implementation of the CreateCatalogParts method must have a value assigned to its ID property, otherwise an exception will be thrown when the collection is assigned to the CatalogParts property.

The method can create the CatalogPart controls from several sources: controls that are declared in persistence format within a DeclarativeCatalogPart control, or controls that are persisted in various storage mechanisms, such as an XML file or a database.

Notes to Inheritors:

Developers who create custom CatalogPart controls should inherit from the CatalogZoneBase or CatalogZone classes, and override this method if they want to create a custom CatalogPartChrome object to render their custom CatalogPart controls.

.NET Framework
Available since 2.0
Return to top
Show: