Sdílet prostřednictvím

WebPartDescription.Description Vlastnost

  • Reference

Definice

Obor názvů:
System.Web.UI.WebControls.WebParts
Sestavení:
System.Web.dll

Získá text popisu WebPart ovládacího prvku.

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

Hodnota vlastnosti

String

Řetězec obsahující popis WebPart ovládacího prvku; výchozí hodnota je prázdný řetězec ("").

Příklady

Následující příklad kódu ukazuje programové použití Description vlastnosti. Úplný kód potřebný ke spuštění tohoto příkladu kódu najdete v části Příklad tématu přehledu WebPartDescription třídy.

Následující kód v Button1_Click metodě webové stránky ukazuje, jak získat kolekci WebPartDescription objektů v katalogu pomocí GetAvailableWebPartDescriptions metody a pak zobrazit podrobnosti o každém WebPart ovládacím prvku v katalogu smyčkou mezi WebPartDescription objekty. Všimněte si, že Description hodnota vlastnosti je načtena v následujícím kódu.

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

Poznámky

Vlastnost Description odpovídá přímo Part.Description vlastnosti. Pokud je tato vlastnost nastavena na ovládací prvek WebPart , vlastnost v odpovídajícím WebPartDescription objektu bude mít také hodnotu.

Vlastnost Description platí pouze v případě, že je stránka v režimu zobrazení katalogu a WebPart ovládací prvek se zobrazuje v katalogu ovládacích prvků. Pokud má ovládací prvek přiřazený popis, zobrazí se popis v katalogu jako popis ovládacího prvku.

Platí pro

Viz také