WebPartDescription.Description Eigenschap
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Hiermee haalt u de tekst van een beschrijving voor een WebPart besturingselement op.
public:
property System::String ^ Description { System::String ^ get(); };public string Description { get; }member this.Description : stringPublic ReadOnly Property Description As StringWaarde van eigenschap
Een tekenreeks die de beschrijving voor een WebPart besturingselement bevat; de standaardwaarde is een lege tekenreeks ("").
Voorbeelden
In het volgende codevoorbeeld ziet u een programmatisch gebruik van de Description eigenschap. Zie de sectie Voorbeeld van het WebPartDescription onderwerp Class Overview voor de volledige code die is vereist voor het uitvoeren van dit codevoorbeeld.
De volgende code in de Button1_Click methode van een webpagina laat zien hoe u de verzameling objecten in een catalogus ophaalt met behulp van WebPartDescription de GetAvailableWebPartDescriptions methode en vervolgens de details van elk WebPart besturingselement in de catalogus weergeeft door de WebPartDescription objecten te doorlopen. Houd er rekening mee dat de Description eigenschapswaarde wordt opgehaald in de volgende code.
protected void Button1_Click(object sender, EventArgs e)
{
Label1.Text = String.Empty;
WebPartDescriptionCollection descriptions =
DeclarativeCatalogPart1.GetAvailableWebPartDescriptions();
foreach (WebPartDescription desc in descriptions)
{
Label1.Text += "ID: " + desc.ID + "<br />" +
"Title: " + desc.Title + "<br />" +
"Description: " + desc.Description + "<br />" +
"ImageUrl: " + desc.CatalogIconImageUrl + "<br />" +
"<hr />";
}
}
Protected Sub Button1_Click(ByVal sender As Object, _
ByVal e As System.EventArgs)
Label1.Text = String.Empty
Dim descriptions As WebPartDescriptionCollection = _
DeclarativeCatalogPart1.GetAvailableWebPartDescriptions()
Dim desc As WebPartDescription
For Each desc In descriptions
Label1.Text += "ID: " & desc.ID & "<br />" & _
"Title: " & desc.Title & "<br />" & _
"Description: " & desc.Description & "<br />" & _
"ImageUrl: " & desc.CatalogIconImageUrl & "<br />" & _
"<hr />"
Next
End Sub
Opmerkingen
De Description eigenschap komt rechtstreeks overeen met de Part.Description eigenschap. Als deze eigenschap is ingesteld op een WebPart besturingselement, heeft de eigenschap in het bijbehorende WebPartDescription object ook een waarde.
De Description eigenschap is alleen van toepassing wanneer een pagina zich in de catalogusweergavemodus bevindt en een WebPart besturingselement wordt weergegeven in een catalogus met besturingselementen. Als aan het besturingselement een beschrijving is toegewezen, wordt de beschrijving in de catalogus weergegeven als knopinfo op het besturingselement.
