WebPartDescriptionCollection Class

Consists of a collection of WebPartDescription objects to be used with catalogs of WebPart controls. This class cannot be inherited.

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

[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public sealed class WebPartDescriptionCollection : ReadOnlyCollectionBase

The WebPartDescriptionCollection class is created by the various CatalogPart controls in their implementations of the GetAvailableWebPartDescriptions method. For each WebPart control that is contained in a CatalogPart control, a WebPartDescription object is created. This object maintains basic information about a WebPart control, including its ID, its title, its description, and a path to an associated icon. The various CatalogPart controls can use a WebPartDescription object to display a WebPart control's information in the catalog, without having to create an instance of the WebPart control itself.

The WebPartDescriptionCollection class is used internally by the Web Parts control set to maintain a collection of all the WebPartDescription objects used in a catalog. The WebPartDescriptionCollection collection is used only when a page is in catalog display mode. When a CatalogPart control is being rendered, it loops through the WebPartDescriptionCollection collection, adding the information from each WebPartDescription object to the displayed catalog.

System.Object
  System.Collections.ReadOnlyCollectionBase
    System.Web.UI.WebControls.WebParts.WebPartDescriptionCollection

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft