CatalogPart.GetAvailableWebPartDescriptions Methode

Definition

Gibt eine Auflistung der Beschreibungen der verfügbaren WebPart-Steuerelemente in einem Katalog zurück.

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

Gibt zurück

Eine WebPartDescriptionCollection, die eine WebPartDescription für jedes Steuerelement in einem Katalog enthält.

Hinweise

Die GetAvailableWebPartDescriptions -Methode gibt Beschreibungsinformationen für jedes Steuerelement in einem Katalog zurück. Ein WebPartDescription Objekt ist ein einfaches Objekt, das wichtige Informationen zu einem WebPart Steuerelement enthält, einschließlich seiner ID, einem Objektverweis auf das Steuerelement und den Werten mehrerer wichtiger Eigenschaften, die von der Basisklasse Part geerbt werden, z Title . B. und Description.

Die GetAvailableWebPartDescriptions Methode verbessert die Leistung. Wenn ein Katalog erstellt wird, benötigt er einige Informationen zu jedem steuerelement, das er enthält, einschließlich eines Titels, einer Beschreibung, eines Symbols (sofern vorhanden) und einer ID. Anstatt eine Instanz jedes Steuerelements erstellen zu müssen, um diese Informationen abzurufen, kann ein Aufrufer die GetAvailableWebPartDescriptions -Methode verwenden, die nur die Beschreibungsinformationen zu den einzelnen Steuerelementen zurückgibt.

Hinweise für Ausführende

Die GetAvailableWebPartDescriptions() Methode ist abstrakt, daher muss sie von abgeleiteten CatalogPart Steuerelementen implementiert werden. Diese Methode wird von der Zone aufgerufen, die ein CatalogPart Steuerelement enthält, und von einem zugeordneten CatalogPartChrome Objekt, wenn der Inhalt einer CatalogZoneBase Zone gerendert wird.

Gilt für:

Weitere Informationen