Condividi tramite

WebPartDescription.Description Proprietà

Definizione

Spazio dei nomi:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Ottiene il testo di una descrizione per un WebPart controllo .

public:
 property System::String ^ Description { System::String ^ get(); };
public string Description { get; }
member this.Description : string
Public ReadOnly Property Description As String

Valore della proprietà

String

Stringa contenente la descrizione di un WebPart controllo; il valore predefinito è una stringa vuota ("").

Esempio

Nell'esempio di codice seguente viene illustrato l'uso a livello di codice della Description proprietà . Per il codice completo necessario per eseguire questo esempio di codice, vedere la sezione Esempio dell'argomento panoramica della WebPartDescription classe.

Il codice seguente nel Button1_Click metodo di una pagina Web illustra come ottenere la raccolta di WebPartDescription oggetti in un catalogo usando il GetAvailableWebPartDescriptions metodo e quindi visualizzare i dettagli di ogni WebPart controllo nel catalogo eseguendo un ciclo tra gli WebPartDescription oggetti . Si noti che il valore della Description proprietà viene recuperato nel codice seguente.

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

Commenti

La Description proprietà corrisponde direttamente alla Part.Description proprietà . Se tale proprietà è impostata su un WebPart controllo, anche la proprietà nell'oggetto corrispondente WebPartDescription avrà un valore.

La Description proprietà si applica solo quando una pagina è in modalità di visualizzazione del catalogo e un WebPart controllo viene visualizzato in un catalogo di controlli. Se al controllo è assegnata una descrizione, la descrizione viene visualizzata nel catalogo come descrizione comando nel controllo .

Si applica a

Vedi anche