Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
WebPartDescriptionCollection Class
Collapse the table of content
Expand the table of content

WebPartDescriptionCollection Class

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

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

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

[<Sealed>]
type WebPartDescriptionCollection =  
    class 
        inherit ReadOnlyCollectionBase 
    end

The WebPartDescriptionCollection type exposes the following members.

  NameDescription
Public methodWebPartDescriptionCollection()Initializes an empty new instance of the WebPartDescriptionCollection class.
Public methodWebPartDescriptionCollection(ICollection)Initializes a new instance of a WebPartDescriptionCollection object by passing in an ICollection collection of WebPartDescription objects.
Top

  NameDescription
Public propertyCountGets the number of elements contained in the ReadOnlyCollectionBase instance. (Inherited from ReadOnlyCollectionBase.)
Public propertyItem(Int32)Gets a member of the collection based on its index within the collection.
Public propertyItem(String)Gets a member of the collection based on a unique string identifier.
Top

  NameDescription
Public methodContainsReturns a value indicating whether a particular control exists in the collection.
Public methodCopyToCopies the collection to an array of WebPartDescription objects.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that iterates through the ReadOnlyCollectionBase instance. (Inherited from ReadOnlyCollectionBase.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfReturns the position of a particular member of the collection.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToCopies the entire ReadOnlyCollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from ReadOnlyCollectionBase.)
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedGets a value indicating whether access to a ReadOnlyCollectionBase object is synchronized (thread safe). (Inherited from ReadOnlyCollectionBase.)
Explicit interface implemetationPrivate propertyICollection.SyncRootGets an object that can be used to synchronize access to a ReadOnlyCollectionBase object. (Inherited from ReadOnlyCollectionBase.)
Top

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.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

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