WebPartDescription.Description Proprietà

  • Riferimento

Definizione

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

Ottiene il testo di una descrizione per un controllo WebPart.

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 che contiene la descrizione di un controllo WebPart. 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 oggetti in un catalogo usando il GetAvailableWebPartDescriptions metodo e quindi visualizzare i dettagli di WebPartDescription ogni WebPart controllo nel catalogo eseguendo il ciclo degli 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, la proprietà nell'oggetto corrispondente WebPartDescription avrà anche un valore.

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

Si applica a

Vedi anche