IWebPart.Subtitle Propriedade

Definição

Espaço de Nomes:
System.Web.UI.WebControls.WebParts
Assemblagem:
System.Web.dll

Obtém uma cadeia que é concatenada com o Title valor da propriedade para formar um título completo para um WebPart controlo.

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

Valor de Propriedade

String

Uma cadeia que serve de subtítulo para o controlo. O valor padrão é uma cadeia vazia ("").

Exemplos

O exemplo de código seguinte demonstra o uso declarativo e programático da Subtitle propriedade. O código-fonte completo do exemplo encontra-se na secção Exemplo da IWebPart visão geral da classe.

A primeira parte do exemplo do código mostra como o controlo do utilizador implementa a Subtitle propriedade. Note que a propriedade é apenas de leitura e destina-se a ser usada para fornecer um subtítulo padrão que é acrescentado ao título principal de um controlo.

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

A segunda parte do exemplo do código mostra como o controlo do utilizador que implementa a IWebPart interface é referenciado num WebPartZone controlo, e como as propriedades graváveis de IWebPart são definidas declarativamente no controlo. Depois de carregar a página num navegador, note que o valor padrão da Subtitle propriedade, que foi definido no código de implementação do controlo de utilizador, é acrescentado ao título na barra de título do controlo.

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

Observações

A Subtitle propriedade é usada para devolver uma cadeia de legendas padrão para um WebPart controlo que é anexada ao título do controlo na barra de título.

Se fornecer um valor padrão para a Subtitle propriedade num controlo que implementa a IWebPart interface, o conjunto de controlo Web Parts adiciona-o automaticamente ao valor da Title propriedade do controlo em tempo de execução.

Aplica-se a

Ver também