IWebPart.Subtitle Propriété

  • Référence

Définition

Espace de noms:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Obtient une chaîne concaténée avec la valeur de la propriété Title pour constituer le titre complet d'un contrôle WebPart.

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

Valeur de propriété

String

Chaîne qui s'utilise en tant que sous-titre pour le contrôle. La valeur par défaut est une chaîne vide ("").

Exemples

L’exemple de code suivant illustre l’utilisation déclarative et programmatique de la Subtitle propriété . Le code source complet de l’exemple se trouve dans la section Exemple de la vue d’ensemble de la IWebPart classe.

La première partie de l’exemple de code montre comment le contrôle utilisateur implémente la Subtitle propriété . Notez que la propriété est en lecture seule et qu’elle est destinée à être utilisée pour fournir un sous-titre par défaut ajouté au titre principal d’un contrôle.

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

La deuxième partie de l’exemple de code montre comment le contrôle utilisateur qui implémente l’interface IWebPart est référencé dans un WebPartZone contrôle et comment les propriétés accessibles en écriture de IWebPart sont définies de manière déclarative sur le contrôle. Après avoir chargé la page dans un navigateur, notez que la valeur par défaut de la Subtitle propriété, qui a été définie dans le code d’implémentation du contrôle utilisateur, est ajoutée au titre dans la barre de titre du contrôle.

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

Remarques

La Subtitle propriété est utilisée pour renvoyer une chaîne de sous-titre par défaut pour un WebPart contrôle ajouté au titre du contrôle dans la barre de titre.

Si vous fournissez une valeur par défaut pour la Subtitle propriété dans un contrôle qui implémente l’interface IWebPart , le jeu de contrôles WebPart l’ajoute automatiquement à la valeur de la Title propriété du contrôle au moment de l’exécution.

S’applique à

Voir aussi