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 управления, включая его идентификатор, ссылку на объект и значения нескольких важных свойств, унаследованных от базового Part класса, таких как Title и Description.

Метод GetAvailableWebPartDescriptions повышает производительность. При создании каталога ему требуются некоторые сведения о каждом элементе управления, который он содержит, включая заголовок, описание, значок (если он существует) и идентификатор. Вместо создания экземпляра каждого элемента управления для получения этих сведений вызывающий объект может использовать GetAvailableWebPartDescriptions метод , который возвращает только описание каждого элемента управления.

Примечания для тех, кто реализует этот метод

Метод GetAvailableWebPartDescriptions() является абстрактным, поэтому он должен быть реализован производными CatalogPart элементами управления. Этот метод вызывается зоной, содержащей элемент управления, и связанным CatalogPartChrome объектом при отрисовки CatalogPart содержимого CatalogZoneBase зоны.

См. также раздел

• элементы управления веб-частей ASP.NET