Поделиться через

Part.Description Свойство

Определение

Пространство имен:
System.Web.UI.WebControls.WebParts
Сборка:
System.Web.dll

Получает или задает краткую фразу, которая суммирует то, что делает элемент управления частью, для использования в подсказках и каталогах элементов управления частью.

public:
 virtual property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };
public virtual string Description { get; set; }
member this.Description : string with get, set
Public Overridable Property Description As String

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

String

Строка, которая кратко описывает функциональные возможности элемента управления частью. Значение по умолчанию — пустая строка ("").

Примеры

В следующем примере кода показано декларативное использование Description свойства в элементе управления частью. В этом примере требуется пользовательский WebPart элемент управления TextDisplayWebPart, который можно найти в разделе Part "Пример" сводки класса.

После загрузки страницы в браузере при расположении указателя мыши на текст заголовка первого экземпляра элемента управления текст описания отображается в подсказке.

<%@ page language="C#" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.CS.Controls" 
             Assembly="TextDisplayWebPartCS" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            Description="A text content WebPart control."
            ChromeType="TitleAndBorder"
            width="350px" />
        </zonetemplate>
    </asp:webpartzone>
    <asp:webpartzone
      id="WebPartZone2"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart2" 
            title = "Text Content WebPart 2" 
            Description="A text content WebPart control."
            ChromeType="TitleOnly"
            ChromeState="Minimized"
            width="350px" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

<%@ page language="VB" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.VB.Controls" 
             Assembly="TextDisplayWebPartVB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            Description="A text content WebPart control."
            ChromeType="TitleAndBorder"
            width="350px" />
        </zonetemplate>
    </asp:webpartzone>
    <asp:webpartzone
      id="WebPartZone2"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart2" 
            title = "Text Content WebPart 2" 
            Description="A text content WebPart control."
            ChromeType="TitleOnly"
            ChromeState="Minimized"
            width="350px" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

Комментарии

Свойство Description обычно представляет собой строку, которая используется в каталогах, которые предоставляют списки элементов управления частью и в виде подсказки в строке заголовка элемента управления частью. Содержимое Description подсказки отображается при расположении указателя мыши на текст заголовка в строке заголовка элемента управления частью. Текст подсказки DisplayTitle создается из значения свойства, за которым следует дефис, а затем Description значение свойства.

Значение этого свойства, если задано, можно автоматически сохранить в файл ресурсов с помощью средства конструктора. Дополнительные сведения см. в статье LocalizableAttribute и глобализации и локализации.

Примечания для тех, кто наследует этот метод

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

Применяется к

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