Part.Description Eigenschap

Definitie

Naamruimte:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Hiermee haalt u een korte woordgroep op die samenvat wat het onderdeelbesturingselement doet, voor gebruik in Knopinfo en catalogi van onderdeelbesturingselementen.

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

Waarde van eigenschap

String

Een tekenreeks die de functionaliteit van het onderdeelbeheer kort samenvat. De standaardwaarde is een lege tekenreeks ("").

Voorbeelden

In het volgende codevoorbeeld ziet u het declaratieve gebruik van de Description eigenschap in een onderdeelbesturingselement. Voor dit voorbeeld is het aangepaste WebPart besturingselement TextDisplayWebPartvereist, dat u kunt vinden in het gedeelte Voorbeeld van de Part klassamenvatting.

Nadat u de pagina in een browser hebt geladen en u de muisaanwijzer op de titeltekst van het eerste besturingselementexemplaren plaatst, wordt de beschrijvingstekst weergegeven in knopinfo.

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

Opmerkingen

De Description eigenschap is doorgaans een tekenreeks die wordt gebruikt in catalogi die lijsten met onderdeelbesturingselementen bevatten en als knopinfo op de titelbalk van het onderdeelbesturingselement. De inhoud van de Description tekst wordt weergegeven in knopinfo wanneer u de muisaanwijzer boven de titeltekst in de titelbalk van een onderdeel plaatst. De tekst voor knopinfo wordt gemaakt op basis van de waarde van de DisplayTitle eigenschap, gevolgd door een afbreekstreepje, gevolgd door de Description eigenschapswaarde.

De waarde van deze eigenschap, wanneer deze is ingesteld, kan automatisch worden opgeslagen in een resourcebestand met behulp van een ontwerpprogramma. Zie en Globalisatie en Lokalisatie voor meer informatieLocalizableAttribute.

Notities voor overnemers

Afgeleide klassen, zoals WebPart kunnen worden overschreven Description om de persoonlijke instellingen van het besturingselement mogelijk te maken.

Van toepassing op

Zie ook