IWebPart.TitleIconImageUrl 属性

参考

定义

命名空间:: System.Web.UI.WebControls.WebParts

程序集:: System.Web.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

获取或设置图像的 URL，该图像用于在控件自身的标题栏中表示 Web 部件控件。

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

代码示例的第三部分演示如何在控件中WebPartZone引用实现接口IWebPart的用户控件，以及如何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 控件相关联的方法。图标显示在控件自己的标题栏中。为了保持主题一致性，应用程序开发人员可能希望使此图标类似于表示 Web 部件控件目录中的控件的图像， (属性) 中 CatalogIconImageUrl 引用的图像。

由于它在 Web 部件控件集中实现， TitleIconImageUrl 因此最终用户可以个性化属性，以更改控件标题栏中显示的图像或图标。

适用于

通过

IWebPart.TitleIconImageUrl 属性

定义

属性值

示例

注解

适用于

另请参阅

其他资源