CatalogPart.GetAvailableWebPartDescriptions Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns a collection of descriptions of the available WebPart controls in a catalog.
public:
abstract System::Web::UI::WebControls::WebParts::WebPartDescriptionCollection ^ GetAvailableWebPartDescriptions();public abstract System.Web.UI.WebControls.WebParts.WebPartDescriptionCollection GetAvailableWebPartDescriptions ();abstract member GetAvailableWebPartDescriptions : unit -> System.Web.UI.WebControls.WebParts.WebPartDescriptionCollectionPublic MustOverride Function GetAvailableWebPartDescriptions () As WebPartDescriptionCollectionReturns
A WebPartDescriptionCollection that contains a WebPartDescription for each control in a catalog.
Remarks
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 Implementers
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.
