IWebPart.Subtitle Eigenschap

Definitie

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

Hiermee haalt u een tekenreeks op die is samengevoegd met de Title eigenschapswaarde om een volledige titel voor een WebPart besturingselement te vormen.

public:
 property System::String ^ Subtitle { System::String ^ get(); };
public string Subtitle { get; }
member this.Subtitle : string
Public ReadOnly Property Subtitle As String

Waarde van eigenschap

String

Een tekenreeks die fungeert als ondertitel voor het besturingselement. De standaardwaarde is een lege tekenreeks ("").

Voorbeelden

In het volgende codevoorbeeld ziet u het declaratieve en programmatische gebruik van de Subtitle eigenschap. De volledige broncode voor het voorbeeld vindt u in de sectie Voorbeeld van het IWebPart klassenoverzicht.

In het eerste deel van het codevoorbeeld ziet u hoe het gebruikersbesturingselement de Subtitle eigenschap implementeert. Houd er rekening mee dat de eigenschap alleen-lezen is en bedoeld is om een standaardondertitel te bieden die wordt toegevoegd aan de hoofdtitel van een besturingselement.

public string Subtitle
{
  get
  {
    object objSubTitle = ViewState["Subtitle"];
    if (objSubTitle == null)
      return "My Subtitle";

    return (string)objSubTitle;
  }

}

ReadOnly Property Subtitle() As String _
  Implements IWebPart.Subtitle
  Get
    Dim objSubTitle As Object = ViewState("Subtitle")
    If objSubTitle Is Nothing Then
      Return "My Subtitle"
    End If
    Return CStr(objSubTitle)
  End Get
End Property

Het tweede deel van het codevoorbeeld laat zien hoe het gebruikersbeheer dat de IWebPart interface implementeert, wordt verwezen in een WebPartZone besturingselement en hoe de schrijfbare eigenschappen van IWebPart het besturingselement declaratief worden ingesteld op het besturingselement. Nadat u de pagina in een browser hebt geladen, moet u er rekening mee houden dat de standaardwaarde van de Subtitle eigenschap, die is ingesteld in de implementatiecode van het gebruikersbesturingselement, wordt toegevoegd aan de titel in de titelbalk van het besturingselement.

<%@ page language="c#" %>
<%@ register tagprefix="uc1" 
    tagname="AccountUserControlCS" 
    src="AccountUserControlcs.ascx"%>
<!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 runat="server">
    <title>
      Personalizable User Control with IWebPart Properties
    </title>
  </head>
  <body>
    <form id="form1" runat="server">
      <asp:webpartmanager id="WebPartManager1" runat="server" />
      <asp:webpartzone 
        id="zone1" 
        runat="server" 
        headertext="Main" 
        CloseVerb-Enabled="false">
        <zonetemplate>
          <uc1:AccountUserControlCS 
            runat="server" 
            id="accountwebpart" 
            title="Account Form"
            Description="Account Form with default values."
            CatalogIconImageUrl="MyCatalogIcon.gif"
            TitleIconImageUrl="MyTitleIcon.gif"
            TitleUrl="MyUrl.html"/>
        </zonetemplate>
      </asp:webpartzone>    
    </form>
  </body>
</html>

<%@ page language="VB" %>
<%@ register tagprefix="uc1" 
    tagname="AccountUserControlVB" 
    src="AccountUserControlvb.ascx"%>
<!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 runat="server">
    <title>
      Personalizable User Control with IWebPart Properties
    </title>
  </head>
  <body>
    <form id="form1" runat="server">
      <asp:webpartmanager id="WebPartManager1" runat="server" />
      <asp:webpartzone 
        id="zone1" 
        runat="server" 
        headertext="Main" 
        CloseVerb-Enabled="false">
        <zonetemplate>
          <uc1:AccountUserControlVB 
            runat="server" 
            id="accountwebpart" 
            title="Account Form"
            Description="Account Form with default values."
            CatalogIconImageUrl="MyCatalogIcon.gif"
            TitleIconImageUrl="MyTitleIcon.gif"
            TitleUrl="MyUrl.html"/>
        </zonetemplate>
      </asp:webpartzone>    
    </form>
  </body>
</html>

Opmerkingen

De Subtitle eigenschap wordt gebruikt om een standaardondertitelreeks te retourneren voor een WebPart besturingselement dat is toegevoegd aan de titel van het besturingselement in de titelbalk.

Als u een standaardwaarde opgeeft voor de Subtitle eigenschap in een besturingselement waarmee de IWebPart interface wordt geïmplementeerd, wordt deze automatisch toegevoegd aan de waarde van de eigenschap van het Title besturingselement tijdens runtime.

Van toepassing op

Zie ook