Udostępnij za pośrednictwem

Part.Description Właściwość

  • Odwołanie

Definicja

Przestrzeń nazw:
System.Web.UI.WebControls.WebParts
Zestaw:
System.Web.dll

Pobiera lub ustawia krótką frazę, która podsumowuje działanie kontrolki części do użycia w etykietkach narzędzi i katalogach kontrolek części.

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

Wartość właściwości

String

Ciąg, który krótko podsumowuje funkcjonalność kontrolki części. Wartością domyślną jest ciąg pusty ("").

Przykłady

Poniższy przykład kodu ilustruje deklaratywne użycie Description właściwości w kontrolce części. W tym przykładzie jest wymagana kontrolka TextDisplayWebPartniestandardowa WebPart , którą można znaleźć w sekcji Przykład podsumowania Part klasy.

Po załadowaniu strony w przeglądarce, jeśli umieścisz wskaźnik myszy nad tekstem tytułu pierwszego wystąpienia kontrolki, tekst opisu pojawi się w etykietce narzędzia.

<%@ 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>

Uwagi

Właściwość Description jest zazwyczaj ciągiem używanym w wykazach, które udostępniają listy kontrolek części, oraz jako etykietkę narzędzia na pasku tytułu kontrolki części. Zawartość elementu Description jest wyświetlana w etykietce narzędzia po ustawieniu wskaźnika myszy nad tekstem tytułu na pasku tytułu kontrolki części. Tekst etykietki narzędzia jest tworzony na podstawie wartości DisplayTitle właściwości, a następnie łącznika, a następnie Description wartości właściwości.

Wartość tej właściwości, po ustawieniu, można zapisać automatycznie w pliku zasobów przy użyciu narzędzia projektanta. Aby uzyskać więcej informacji, zobacz LocalizableAttribute Temat Globalizacja i Lokalizacja.

Uwagi dotyczące dziedziczenia

Klasy pochodne, takie jak WebPart można zastąpić Description , aby umożliwić personalizację użytkownika opisu kontrolki.

Dotyczy

Zobacz też