CatalogPart.GetAvailableWebPartDescriptions 方法

定义

返回目录中可用 WebPart 控件的说明的集合。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.WebPartDescriptionCollection
Public MustOverride Function GetAvailableWebPartDescriptions () As WebPartDescriptionCollection

返回

WebPartDescriptionCollection

一个 WebPartDescriptionCollection,它包含目录中每个控件的 WebPartDescriptionA WebPartDescriptionCollection that contains a WebPartDescription for each control in a catalog.

注解

GetAvailableWebPartDescriptions方法返回目录中每个控件的说明信息。The GetAvailableWebPartDescriptions method returns description information for each control in a catalog. WebPartDescription对象是一个轻型对象,其中包含有关控件的基本信息 WebPart ,包括控件的 ID、对控件的对象引用,以及从基类继承的几个重要属性的值 Part ,例如 TitleDescriptionA 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.

GetAvailableWebPartDescriptions方法可提高性能。The GetAvailableWebPartDescriptions method improves performance. 创建目录时,它需要一些有关它所包含的每个控件的信息,包括标题、描述、图标 ((如果存在)) 和 ID。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. 调用方可以使用 GetAvailableWebPartDescriptions 方法,该方法只返回有关每个控件的说明信息,而无需创建每个控件的实例即可获取此信息。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.

实施者说明

GetAvailableWebPartDescriptions()方法是抽象的,因此它必须由派生控件实现 CatalogPartThe GetAvailableWebPartDescriptions() method is abstract, so it must be implemented by derived CatalogPart controls. 此方法由包含控件的区域 CatalogPart 和关联的 CatalogPartChrome 对象在区域的内容呈现时调用 CatalogZoneBaseThis 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.

适用于