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

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

注意 (実装者)

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

こちらもご覧ください

• ASP.NET Web パーツ コントロール