CatalogPart.GetAvailableWebPartDescriptions メソッド

定義

名前空間:
System.Web.UI.WebControls.WebParts
アセンブリ:
System.Web.dll

カタログ内の使用可能な 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 クラスから継承されたいくつかの重要なプロパティ (TitleやDescriptionなど) の値を含む軽量オブジェクトです。

GetAvailableWebPartDescriptionsメソッドを使用すると、パフォーマンスが向上します。 カタログを作成するときは、タイトル、説明、アイコン (存在する場合)、ID など、カタログに含まれる各コントロールに関する情報が必要です。 呼び出し元は、この情報を取得するために各コントロールのインスタンスを作成する必要はなく、各コントロールに関する説明情報のみを返す GetAvailableWebPartDescriptions メソッドを使用できます。

注意 (実装者)

GetAvailableWebPartDescriptions() メソッドは抽象メソッドであるため、派生CatalogPart コントロールによって実装する必要があります。 このメソッドは、CatalogPart コントロールを含むゾーンと、CatalogPartChrome ゾーンのコンテンツがレンダリングされるときに関連付けられたCatalogZoneBase オブジェクトによって呼び出されます。

適用対象

こちらもご覧ください