WebPartDescription.Description Свойство

Определение

Пространство имен:

System.Web.UI.WebControls.WebParts

Сборка:

System.Web.dll

Получает текст описания элемента управления WebPart.

public:
 property System::String ^ Description { System::String ^ get(); };

public string Description { get; }

member this.Description : string

Public ReadOnly Property Description As String

Значение свойства

String

Строка, содержащая описание элемента управления WebPart. Значением по умолчанию является пустая строка ("").

Примеры

В следующем примере кода показано программное использование Description свойства . Полный код, необходимый для выполнения этого примера кода, см. в разделе WebPartDescription Пример раздела обзора класса.

В следующем коде в методе Button1_Click веб-страницы показано, как получить коллекцию WebPartDescription объектов в каталоге с помощью GetAvailableWebPartDescriptions метода , а затем отобразить сведения о каждом WebPart элементе управления в каталоге путем циклического перебора WebPartDescription объектов . Обратите внимание, что Description значение свойства извлекается в следующем коде.

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

Комментарии

Свойство Description соответствует непосредственно свойству Part.Description . Если это свойство задано для WebPart элемента управления , то свойство в соответствующем WebPartDescription объекте также будет иметь значение .

Свойство Description применяется только в том случае, если страница находится в режиме отображения каталога, а WebPart элемент управления отображается в каталоге элементов управления. Если элементу управления назначено описание, оно отображается в каталоге в виде подсказки элемента управления.

См. также раздел

• Description
• элементы управления веб-частей ASP.NET