WebPart.TitleIconImageUrl プロパティ

  • リファレンス

定義

名前空間:
System.Web.UI.WebControls.WebParts
アセンブリ:
System.Web.dll

Web パーツ コントロールのタイトル バーでそのコントロールを表すために使用されるイメージへの URL を取得または設定します。

public:
 virtual property System::String ^ TitleIconImageUrl { System::String ^ get(); void set(System::String ^ value); };
[System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)]
public virtual string TitleIconImageUrl { get; set; }
[<System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)>]
member this.TitleIconImageUrl : string with get, set
Public Overridable Property TitleIconImageUrl As String

プロパティ値

String

コントロールをそのタイトル バー内で表すために使用されるイメージへの URL を表す文字列。 既定値は空の文字列 ("") です。

実装

TitleIconImageUrl
属性
PersonalizableAttribute

例外

ArgumentException

内部の検証システムによって、URL にスクリプト攻撃が含まれている可能性があることが確認されました。

例

次のコード例では、カスタム Web パーツ コントロールの プロパティを TitleIconImageUrl 設定して、コントロールがコントロールのカタログに画像と共に表示されるようにする方法を示します。 この例では、 TextDisplayWebPartクラスの概要の「例」セクションで作成されたカスタム コントロール の使用を WebPart 前提としています。

Web ページの宣言型マークアップで、 要素を <aspSample:TextDisplayWebPart> メモします。 その TitleIconImageUrl 属性には、イメージ ファイルの URL を含む文字列が割り当てられます。 ブラウザーでページを読み込み、イメージに正当な URL を指定した場合、イメージはコントロールのタイトル バーに WebPart 表示されます。

<%@ page language="C#" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.CS.Controls" 
             Assembly="TextDisplayWebPartCS"%>

<!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 id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      title="Zone 1"
      PartChromeType="TitleAndBorder">
        <parttitlestyle font-bold="true" ForeColor="#3300cc" />
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            TitleIconImageUrl="MyImage.gif" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

<%@ page language="VB" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.VB.Controls" 
             Assembly="TextDisplayWebPartVB"%>

<!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 id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      title="Zone 1"
      PartChromeType="TitleAndBorder">
        <parttitlestyle font-bold="true" ForeColor="#3300cc" />
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            TitleIconImageUrl="MyImage.gif" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

注釈

このプロパティのパーソナル化スコープは に Shared 設定され、承認されたユーザーのみが変更できます。 詳細については、「および Web パーツのパーソナル化の概要」を参照してくださいPersonalizableAttribute。

適用対象

こちらもご覧ください