CatalogPart.GetAvailableWebPartDescriptions メソッド

.NET Framework クラス ライブラリ リファレンス

CatalogPart.GetAvailableWebPartDescriptions メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

カタログ内の使用できる WebPart コントロールの説明のコレクションを返します。

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public MustOverride Function
 GetAvailableWebPartDescriptions As WebPartDescriptionCollection

Visual Basic (使用法)

Dim instance As CatalogPart
Dim returnValue As WebPartDescriptionCollection

returnValue = instance.GetAvailableWebPartDescriptions

C#

public abstract WebPartDescriptionCollection GetAvailableWebPartDescriptions
 ()

C++

public:
virtual WebPartDescriptionCollection^ GetAvailableWebPartDescriptions () abstract

J#

public abstract WebPartDescriptionCollection GetAvailableWebPartDescriptions
 ()

JScript

public abstract function GetAvailableWebPartDescriptions
 () : WebPartDescriptionCollection

戻り値
カタログ内の各コントロールの WebPartDescription を含んでいる WebPartDescriptionCollection。

解説

GetAvailableWebPartDescriptions メソッドは、カタログ内の各コントロールの説明情報を返します。WebPartDescription オブジェクトは、WebPart コントロールに関する基本的な情報を含んでいる軽量オブジェクトです。この情報には、基本 Part クラスから継承する複数の重要なプロパティ値 (コントロールの ID、コントロールへのオブジェクト参照、Title、Description など) が含まれています。

GetAvailableWebPartDescriptions メソッドを使用すると、パフォーマンスが向上します。カタログが作成される場合、そこに格納される各コントロールの情報の一部が必要になります。この情報には、タイトル、説明、アイコン (存在する場合)、および ID が含まれます。各コントロールのインスタンスを作成してこの情報を取得する代わりに GetAvailableWebPartDescriptions メソッドを使用すると、呼び出し元に各コントロールの説明情報だけを返すことができます。

継承時の注意 GetAvailableWebPartDescriptions メソッドは抽象型であるため、派生 CatalogPart コントロールによって実装される必要があります。このメソッドは、CatalogPart コントロールを含むゾーン、および CatalogZoneBase ゾーンの内容が表示されている場合は関連付けられた CatalogPartChrome オブジェクトによって呼び出されます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
CatalogPart クラス
CatalogPart メンバ
System.Web.UI.WebControls.WebParts 名前空間
その他の技術情報
ASP.NET Web パーツ ページ