WebPartDescription.CatalogIconImageUrl Propriété

  • Référence

Définition

Espace de noms:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Obtient une URL qui contient le chemin d'accès vers une image utilisée comme icône pour un contrôle WebPart.

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

Valeur de propriété

String

Chaîne qui contient une URL ; la valeur par défaut est une chaîne vide ("").

Exemples

L’exemple de code suivant illustre l’utilisation par programmation de la CatalogIconImageUrl propriété . Pour obtenir le code complet requis pour exécuter cet exemple de code, consultez la section Exemple de la rubrique Vue d’ensemble de la WebPartDescription classe.

Le code suivant dans la Button1_Click méthode d’une page Web montre comment obtenir la collection d’objets WebPartDescription d’un catalogue à l’aide de la GetAvailableWebPartDescriptions méthode , puis afficher les détails de chaque WebPart contrôle dans le catalogue en effectuant une boucle dans les WebPartDescription objets. Notez que la valeur de la CatalogIconImageUrl propriété est récupérée dans le code suivant.

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

Remarques

La CatalogIconImageUrl propriété correspond directement à la WebPart.CatalogIconImageUrl propriété . Si cette propriété est définie sur un WebPart contrôle, la propriété dans l’objet correspondant WebPartDescription aura également une valeur.

La CatalogIconImageUrl propriété s’applique uniquement lorsqu’une page est en mode d’affichage catalogue et qu’un WebPart contrôle est affiché dans un catalogue de contrôles. Si une icône est affectée au contrôle dans la valeur de propriété, l’icône apparaît dans le catalogue en regard du contrôle.

S’applique à

Voir aussi