IWebPart.Subtitle Propriedade

  • Referência

Definição

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

Obtém uma cadeia de caracteres que é concatenada com o valor da propriedade Title para compor um título completo para um controle WebPart.

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

Valor da propriedade

String

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

Exemplos

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

A primeira parte do exemplo de código mostra como o controle de usuário implementa a Subtitle propriedade . Observe que a propriedade é somente leitura e deve ser usada para fornecer um subtítulo padrão que é acrescentado ao título principal de um controle.

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 de código mostra como o controle de usuário que implementa a IWebPart interface é referenciado em um WebPartZone controle e como as propriedades graváveis de IWebPart são definidas declarativamente no controle. Depois de carregar a página em um navegador, observe que o valor padrão da Subtitle propriedade, que foi definido no código de implementação do controle de usuário, é acrescentado ao título na barra de título do controle.

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

Comentários

A Subtitle propriedade é usada para retornar uma cadeia de caracteres de subtítulo padrão para um WebPart controle que é acrescentado ao título do controle na barra de título.

Se você fornecer um valor padrão para a Subtitle propriedade em um controle que implementa a IWebPart interface , o conjunto de controle de Web Parts o anexará automaticamente ao valor da Title propriedade do controle em tempo de execução.

Aplica-se a

Confira também