Share via

IWebPart.Subtitle Свойство

  • Ссылка

Определение

Пространство имен:
System.Web.UI.WebControls.WebParts
Сборка:
System.Web.dll

Возвращает строку, которая объединены со значением свойства Title для формирования полного заголовка для элемента управления WebPart.

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

Значение свойства

String

Строка, служащая подзаголовком для элемента управления. Значение по умолчанию — пустая строка.

Примеры

В следующем примере кода демонстрируется декларативное и программное использование Subtitle свойства . Полный исходный код для примера можно найти в разделе Пример в обзоре IWebPart класса.

В первой части примера кода показано, как пользовательский элемент управления реализует Subtitle свойство . Обратите внимание, что свойство доступно только для чтения и предназначено для предоставления субтитра по умолчанию, который добавляется к основному заголовку элемента управления.

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

Во второй части примера кода показано, как пользовательский элемент управления, реализующий IWebPart интерфейс, ссылается в элементе WebPartZone управления и как доступные для записи свойства из IWebPart задаются декларативно в элементе управления . После загрузки страницы в браузере обратите внимание, что значение Subtitle свойства по умолчанию, заданное в коде реализации пользовательского элемента управления, добавляется к заголовку в строке заголовка элемента управления.

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

Комментарии

Свойство Subtitle используется для возврата строки подзаголовка по умолчанию для WebPart элемента управления, который добавляется к заголовку элемента управления в строке заголовка.

Если в элементе управления, реализующего интерфейс, указать IWebPart значение по умолчанию для Subtitle свойства, набор элементов управления веб-частей автоматически добавляет его к значению Title свойства элемента управления во время выполнения.

Применяется к

См. также раздел