Export (0) Print
Expand All

CatalogPart.GetAvailableWebPartDescriptions Method

Returns a collection of descriptions of the available WebPart controls in a catalog.

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

public abstract WebPartDescriptionCollection GetAvailableWebPartDescriptions()

The GetAvailableWebPartDescriptions method returns description information for each control in a catalog. A WebPartDescription object is a lightweight object that contains essential information about a WebPart control, including its ID, an object reference to the control, and the values of several important properties that are inherited from the base Part class, such as Title and Description.

The GetAvailableWebPartDescriptions method improves performance. When a catalog is created, it needs some information about each control it contains, including a title, a description, an icon (if one exists), and an ID. Rather than having to create an instance of each control to get this information, a caller can use the GetAvailableWebPartDescriptions method, which returns only the description information about each control.

Notes to Inheritors

The GetAvailableWebPartDescriptions method is abstract, so it must be implemented by derived CatalogPart controls. This method is called by the zone that contains a CatalogPart control, and by an associated CatalogPartChrome object when the contents of a CatalogZoneBase zone are rendered.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft