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.WebPartDescriptionCollectionPublic MustOverride Function GetAvailableWebPartDescriptions () As WebPartDescriptionCollectionВозвращаемое значение
Коллекция WebPartDescriptionCollection, содержащая объект WebPartDescription для каждого элемента управления в каталоге.
Комментарии
Метод GetAvailableWebPartDescriptions возвращает сведения о описании для каждого элемента управления в каталоге. Объект WebPartDescription — это упрощенный объект, содержащий важные сведения об WebPart элементе управления, включая его идентификатор, ссылку на объект элемента управления, а также значения нескольких важных свойств, унаследованных от базового Part класса, таких как Title и Description.
Этот GetAvailableWebPartDescriptions метод повышает производительность. При создании каталога требуются некоторые сведения о каждом элементе управления, который он содержит, включая заголовок, описание, значок (если таковой существует) и идентификатор. Вместо того, чтобы создать экземпляр каждого элемента управления для получения этих сведений, вызывающий объект может использовать GetAvailableWebPartDescriptions метод, который возвращает только сведения о описании каждого элемента управления.
Примечания для тех, кто реализует этот метод
Метод GetAvailableWebPartDescriptions() является абстрактным, поэтому он должен быть реализован производными CatalogPart элементами управления. Этот метод вызывается зоной, содержащей CatalogPart элемент управления, и связанным CatalogPartChrome объектом при отрисовки содержимого CatalogZoneBase зоны.