Поделиться через

IWebPart.TitleIconImageUrl Свойство

  • Ссылка

Определение

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

Получает или задает URL-адрес изображения, которое используется для представления элемента управления веб-частей в собственном заголовке окна элемента управления.

public:
 property System::String ^ TitleIconImageUrl { System::String ^ get(); void set(System::String ^ value); };
public string TitleIconImageUrl { get; set; }
member this.TitleIconImageUrl : string with get, set
Public Property TitleIconImageUrl As String

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

String

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

Примеры

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

В первой части примера кода показано, как пользовательский элемент управления реализует TitleIconImageUrl свойство .

public string TitleIconImageUrl
{
  get
  {
    object objTitle = ViewState["TitleIconImageUrl"];
    if (objTitle == null)
      return String.Empty;

    return (string)objTitle;
  }
  set
  {
    ViewState["TitleIconImageUrl"] = value;
  }
}

Public Property TitleIconImageUrl() As String _
  Implements IWebPart.TitleIconImageUrl
  Get
    Dim objTitle As Object = ViewState("TitleIconImageUrl")
    If objTitle Is Nothing Then
      Return String.Empty
    End If
    Return CStr(objTitle)
  End Get
  Set(ByVal value As String)
    ViewState("TitleIconImageUrl") = value
  End Set
End Property

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

Важно!

В этом примере имеется текстовое поле, принимающее вводимые пользователем данные, что является потенциальной угрозой безопасности. По умолчанию данные, вводимые пользователем на веб-страницах ASP.NET, проверяются на наличие скриптов и HTML-элементов. Дополнительные сведения см. в разделе Общие сведения об использовании сценариев.

// Update the selected IWebPart property value.
void Button1_Click(object sender, EventArgs e)
{
  String propertyValue = Server.HtmlEncode(TextBox3.Text);
  TextBox3.Text = String.Empty;

  switch (RadioButtonList1.SelectedValue)
  {
    case "title":
      this.Title = propertyValue;
      break;
    case "description":
      this.Description = propertyValue;
      break;
    case "catalogiconimageurl":
      this.CatalogIconImageUrl = propertyValue;
      break;
    case "titleiconimageurl":
      this.TitleIconImageUrl = propertyValue;
      break;
    case "titleurl":
      this.TitleUrl = propertyValue;
      break;
    default:
      break;
  }
}

' Update the selected IWebPart property value.
Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)
  Dim propertyValue As String = Server.HtmlEncode(TextBox3.Text)
  TextBox3.Text = String.Empty
    
  Select Case RadioButtonList1.SelectedValue
    Case "title"
      Me.Title = propertyValue
    Case "description"
      Me.Description = propertyValue
    Case "catalogiconimageurl"
      Me.CatalogIconImageUrl = propertyValue
    Case "titleiconimageurl"
      Me.TitleIconImageUrl = propertyValue
    Case "titleurl"
      Me.TitleUrl = propertyValue
    Case Else
  End Select

End Sub 'Button1_Click

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

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

Комментарии

Свойство TitleIconImageUrl позволяет связать значок с элементом WebPart управления . Значок отображается в строке заголовка элемента управления. Для тематической согласованности разработчикам приложений может потребоваться сделать этот значок похожим на изображение, представляющее элемент управления в каталоге элементов управления веб-частей (изображение, на которое ссылается CatalogIconImageUrl свойство ).

Так как оно реализовано в наборе элементов управления веб-частей, TitleIconImageUrl конечные пользователи могут персонализировать свойство, чтобы изменить изображение или значок, которые отображаются в строке заголовка элемента управления.

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

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