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

注解

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

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

实施者说明

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

适用于

另请参阅