GenericWebPart.Description Свойство
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает или задает краткую фразу, которая суммирует то, что делает элемент управления, для использования в подсказках и каталогах элементов управления сервером.
public:
virtual property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };public override string Description { get; set; }member this.Description : string with get, setPublic Overrides Property Description As StringЗначение свойства
Строка, которая кратко описывает функциональные возможности элемента управления. Значение по умолчанию — пустая строка ("").
Примеры
В следующем примере кода демонстрируется декларативное и программное использование Description свойства. Полный исходный код примера приведен в разделе GenericWebPart "Пример" раздела обзора.
В первой части примера кода показано, как Description свойство устанавливается декларативно на серверном элементе управления в элементе WebPartZone управления.
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<asp:Calendar ID="Calendar1" runat="server"
Title="My Calendar"
Description="A calendar used as a GenericWebPart control."
CatalogIconImageUrl="MyCatalogIcon.gif"
TitleIconimageUrl ="MyTitleIcon.gif"
TitleUrl="MyInfoUrl.htm"
Width="250"/>
</ZoneTemplate>
</asp:WebPartZone>
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<asp:Calendar ID="Calendar1" runat="server"
Title="My Calendar"
Description="A calendar used as a GenericWebPart control."
CatalogIconImageUrl="MyCatalogIcon.gif"
TitleIconimageUrl ="MyTitleIcon.gif"
TitleUrl="MyInfoUrl.htm"
Width="250"/>
</ZoneTemplate>
</asp:WebPartZone>
Вторая часть примера кода демонстрирует, как получить доступ к свойству программным способом, чтобы отобразить его значение в метке.
protected void Button1_Click(object sender, EventArgs e)
{
Label2.Text =
@"<h3>Calendar GenericWebPart Properties</h3>" +
"<em>Title: </em>" + calendarPart.Title +
"<br />" +
"<em>CatalogIconImageUrl: </em>" + calendarPart.CatalogIconImageUrl +
"<br />" +
"<em>TitleUrl: </em>" + calendarPart.TitleUrl +
"<br />" +
"<em>Decription: </em>" + calendarPart.Description +
"<br />" +
"<em>TitleIconImageUrl: </em>" + calendarPart.TitleIconImageUrl +
"<br />" +
"<em>ChildControl ID: </em>" + calendarPart.ChildControl.ID +
"<br />" +
"<em>ChildControl Type: </em>" + calendarPart.ChildControl.GetType().Name +
"<br />" +
"<em>GenericWebPart ID: </em>" + calendarPart.ID +
"<br />" +
"<em>GenericWebPart Type: </em>" + calendarPart.GetType().Name +
"<br />" +
"<em>GenericWebPart Parent ID: </em>" + calendarPart.Parent.ID;
Label3.Text =
@"<h3>BulletedList GenericWebPart Properties</h3>" +
"<em>Title: </em>" + listPart.Title +
"<br />" +
"<em>CatalogIconImageUrl: </em>" + listPart.CatalogIconImageUrl +
"<br />" +
"<em>TitleUrl: </em>" + listPart.TitleUrl +
"<br />" +
"<em>Decription: </em>" + listPart.Description +
"<br />" +
"<em>TitleIconImageUrl: </em>" + listPart.TitleIconImageUrl +
"<br />" +
"<em>ChildControl ID: </em>" + listPart.ChildControl.ID +
"<br />" +
"<em>ChildControl Type: </em>" + listPart.ChildControl.GetType().Name +
"<br />" +
"<em>GenericWebPart ID: </em>" + listPart.ID +
"<br />" +
"<em>GenericWebPart Type: </em>" + listPart.GetType().Name +
"<br />" +
"<em>GenericWebPart Parent ID: </em>" + listPart.Parent.ID;
}
Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)
Label2.Text = _
"<h3>Calendar GenericWebPart Properties</h3>" & _
"<em>Title: </em>" & calendarPart.Title & _
"<br />" & _
"<em>CatalogIconImageUrl: </em>" & calendarPart.CatalogIconImageUrl & _
"<br />" & _
"<em>TitleUrl: </em>" & calendarPart.TitleUrl & _
"<br />" & _
"<em>Decription: </em>" & calendarPart.Description & _
"<br />" & _
"<em>TitleIconImageUrl: </em>" & calendarPart.TitleIconImageUrl & _
"<br />" & _
"<em>ChildControl ID: </em>" & calendarPart.ChildControl.ID & _
"<br />" & _
"<em>ChildControl Type: </em>" & calendarPart.ChildControl.GetType().Name & _
"<br />" & _
"<em>GenericWebPart ID: </em>" & calendarPart.ID & _
"<br />" & _
"<em>GenericWebPart Type: </em>" & calendarPart.GetType().Name & _
"<br />" & _
"<em>GenericWebPart Parent ID: </em>" & calendarPart.Parent.ID
Label3.Text = _
"<h3>BulletedList GenericWebPart Properties</h3>" & _
"<em>Title: </em>" & listPart.Title & _
"<br />" & _
"<em>CatalogIconImageUrl: </em>" & listPart.CatalogIconImageUrl & _
"<br />" & _
"<em>TitleUrl: </em>" & listPart.TitleUrl & _
"<br />" & _
"<em>Decription: </em>" & listPart.Description & _
"<br />" & _
"<em>TitleIconImageUrl: </em>" & listPart.TitleIconImageUrl & _
"<br />" & _
"<em>ChildControl ID: </em>" & listPart.ChildControl.ID & _
"<br />" & _
"<em>ChildControl Type: </em>" & listPart.ChildControl.GetType().Name & _
"<br />" & _
"<em>GenericWebPart ID: </em>" & listPart.ID & _
"<br />" & _
"<em>GenericWebPart Type: </em>" & listPart.GetType().Name & _
"<br />" & _
"<em>GenericWebPart Parent ID: </em>" & listPart.Parent.ID
End Sub
End Class
Комментарии
Description Значение свойства обычно используется в качестве описательной строки для элемента управления в каталогах, которые предоставляют списки элементов управления сервера и в качестве подсказки в строке заголовка элемента управления. Содержимое свойства отображается в подсказке, когда пользователь помещает указатель мыши на текст заголовка в строке заголовка элемента управления.
Это свойство переопределяет базовое свойство, чтобы получить доступ к свойству дочернего элемента управления, как если бы это был истинный WebPart элемент управления.
Значения свойства в элементе управления можно задать в декларативной разметке веб-страницы, а также программно. Чтобы указать значение по умолчанию для свойства всякий раз, когда используется элемент управления, можно реализовать IWebPart интерфейс.
