CatalogPart.GetWebPart Method (WebPartDescription)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Retrieves from a catalog the WebPart control that is referenced by the WebPartDescription object passed to the method.

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

public abstract WebPart GetWebPart(
	WebPartDescription description
)

Parameters

description
Type: System.Web.UI.WebControls.WebParts.WebPartDescription

A WebPartDescription that contains a reference to a specific WebPart.

Return Value

Type: System.Web.UI.WebControls.WebParts.WebPart

A WebPart that is referenced by the object in the description parameter.

The GetWebPart method returns a WebPart control from a catalog. The WebPartDescription object that is passed to the method matches a specific WebPart control and enables that control to be returned by the method.

If a catalog contains a server control that does not derive from the WebPart class, such as an ASP.NET server control, a custom server control, or a user control, a CatalogPart control must wrap the server control with a GenericWebPart control, and return the GenericWebPart control from this method.

Notes to Inheritors:

The GetWebPart method is abstract, so it must be implemented by derived CatalogPart controls. This method is called by the zone that contains a CatalogPart control, by an associated CatalogPartChrome object, and by the WebPartManager object on a Web page.

.NET Framework
Available since 2.0
Return to top
Show: