CatalogPart.GetAvailableWebPartDescriptions 方法

定义

返回目录中可用 WebPart 控件的说明的集合。

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,它包含目录中每个控件的 WebPartDescription

注解

该方法 GetAvailableWebPartDescriptions 返回目录中每个控件的说明信息。 对象 WebPartDescription 是一个轻型对象,其中包含有关 WebPart 控件的基本信息,包括控件 ID、对控件的对象引用以及从基 Part 类继承的几个重要属性的值,例如 TitleDescription

该方法 GetAvailableWebPartDescriptions 可提高性能。 创建目录时,它需要一些有关它包含的每个控件的信息,包括标题、说明、图标 ((如果存在) )和 ID。 调用方无需创建每个控件的实例即可获取此信息,而该方法 GetAvailableWebPartDescriptions 仅返回有关每个控件的说明信息。

实施者说明

该方法 GetAvailableWebPartDescriptions() 是抽象方法,因此它必须由派生 CatalogPart 控件实现。 此方法由包含CatalogPart控件的区域以及呈现区域的内容CatalogZoneBase时由关联的CatalogPartChrome对象调用。

适用于

另请参阅