WebPartDescriptionCollection Class
TOC
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.

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

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

public sealed class WebPartDescriptionCollection : ReadOnlyCollectionBase

NameDescription
System_CAPS_pubmethodWebPartDescriptionCollection()

Initializes an empty new instance of the WebPartDescriptionCollection class.

System_CAPS_pubmethodWebPartDescriptionCollection(ICollection)

Initializes a new instance of a WebPartDescriptionCollection object by passing in an ICollection collection of WebPartDescription objects.

NameDescription
System_CAPS_pubpropertyCount

Gets the number of elements contained in the ReadOnlyCollectionBase instance.(Inherited from ReadOnlyCollectionBase.)

System_CAPS_pubpropertyItem[Int32]

Gets a member of the collection based on its index within the collection.

System_CAPS_pubpropertyItem[String]

Gets a member of the collection based on a unique string identifier.

NameDescription
System_CAPS_pubmethodContains(WebPartDescription)

Returns a value indicating whether a particular control exists in the collection.

System_CAPS_pubmethodCopyTo(WebPartDescription[], Int32)

Copies the collection to an array of WebPartDescription objects.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Returns an enumerator that iterates through the ReadOnlyCollectionBase instance.(Inherited from ReadOnlyCollectionBase.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIndexOf(WebPartDescription)

Returns the position of a particular member of the collection.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.CopyTo(Array, Int32)

Copies the entire ReadOnlyCollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array.(Inherited from ReadOnlyCollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.IsSynchronized

Gets a value indicating whether access to a ReadOnlyCollectionBase object is synchronized (thread safe).(Inherited from ReadOnlyCollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.SyncRoot

Gets an object that can be used to synchronize access to a ReadOnlyCollectionBase object.(Inherited from ReadOnlyCollectionBase.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

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
Available since 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.

Return to top
Show:
© 2016 Microsoft