WebPartDescription.Description Properti
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Mendapatkan teks deskripsi untuk WebPart kontrol.
public:
property System::String ^ Description { System::String ^ get(); };
public string Description { get; }
member this.Description : string
Public ReadOnly Property Description As String
Nilai Properti
String yang berisi deskripsi untuk WebPart kontrol; nilai defaultnya adalah string kosong ("").
Contoh
Contoh kode berikut menunjukkan penggunaan properti terprogram Description . Untuk kode lengkap yang diperlukan untuk menjalankan contoh kode ini, lihat bagian WebPartDescription Contoh topik gambaran umum kelas.
Kode berikut dalam Button1_Click
metode halaman Web menunjukkan cara mendapatkan kumpulan WebPartDescription objek dalam katalog menggunakan GetAvailableWebPartDescriptions metode , lalu untuk menampilkan detail setiap WebPart kontrol dalam katalog dengan mengulangi WebPartDescription objek. Perhatikan bahwa Description nilai properti diambil dalam kode berikut.
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
Keterangan
Properti Description sesuai langsung dengan Part.Description properti . Jika properti tersebut diatur pada WebPart kontrol, maka properti di objek yang WebPartDescription sesuai juga akan memiliki nilai.
Properti Description hanya berlaku saat halaman berada dalam mode tampilan katalog, dan WebPart kontrol ditampilkan dalam katalog kontrol. Jika kontrol memiliki deskripsi yang ditetapkan untuk kontrol tersebut, deskripsi akan muncul di katalog sebagai TipsAlat pada kontrol.