CatalogPart.GetAvailableWebPartDescriptions Método

Definição

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Retorna uma coleção de descrições dos controles WebPart disponíveis em um catálogo.

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

Retornos

WebPartDescriptionCollection

Um WebPartDescriptionCollection que contém um WebPartDescription para cada controle em um catálogo.

Comentários

O GetAvailableWebPartDescriptions método retorna informações de descrição para cada controle em um catálogo. Um WebPartDescription objeto é um objeto leve que contém informações essenciais sobre um WebPart controle, incluindo sua ID, uma referência de objeto ao controle e os valores de várias propriedades importantes que são herdadas da classe base Part , como Title e Description.

O GetAvailableWebPartDescriptions método melhora o desempenho. Quando um catálogo é criado, ele precisa de algumas informações sobre cada controle que ele contém, incluindo um título, uma descrição, um ícone (se houver) e uma ID. Em vez de precisar criar uma instância de cada controle para obter essas informações, um chamador pode usar o GetAvailableWebPartDescriptions método , que retorna apenas as informações de descrição sobre cada controle.

Notas aos Implementadores

O GetAvailableWebPartDescriptions() método é abstrato, portanto, deve ser implementado por controles derivados CatalogPart . Esse método é chamado pela zona que contém um CatalogPart controle e por um objeto associado CatalogPartChrome quando o conteúdo de uma CatalogZoneBase zona é renderizado.

Confira também

• Controles de Web Parts do ASP.NET