IWebPart.TitleUrl プロパティ

リファレンス

定義

名前空間:: System.Web.UI.WebControls.WebParts

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

WebPart コントロールに関する補足情報の URL を取得または設定します。

public:
 property System::String ^ TitleUrl { System::String ^ get(); void set(System::String ^ value); };

public string TitleUrl { get; set; }

member this.TitleUrl : string with get, set

Public Property TitleUrl As String

プロパティ値

String

WebPart コントロールに関する補足情報の URL を表す文字列。既定値は空の文字列 ("") です。

例

次のコード例では、プロパティの宣言型およびプログラムによる使用を TitleUrl 示します。この例の完全なソースコードについては、クラスの概要の「例」セクションを IWebPart 参照してください。

コード例の最初の部分は、ユーザーコントロールがプロパティを実装する方法を TitleUrl 示しています。

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

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

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

コード例の 2 番目の部分では、ユーザーがページ上の TitleUrl ラジオボタンから適切なプロパティ名を選択し、テキストボックスに新しい値を設定し、[ 更新 ] ボタンをクリックしたときに、プログラムによってプロパティの値を設定するユーザーコントロールのメソッドを示します。

重要

この例には、ユーザー入力を受け付けるテキストボックスがあります。これにより、セキュリティが脆弱になる可能性があります。既定では、ASP.NET Web ページによって、ユーザー入力にスクリプトまたは 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

コード例の 3 番目の部分は、インターフェイスを実装 IWebPart するユーザーコントロールがコントロール内でどのように WebPartZone 参照されているか、およびコントロールに対して TitleUrl 宣言的にプロパティを設定する方法を示しています。実際のページへの 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>

注釈

プロパティに TitleUrl URL を割り当てると、コントロールのタイトルがリンクになります。このプロパティの目的は、エンドユーザーがコントロールに関する追加情報にアクセスするための便利な方法を提供することです。追加情報は、著作権データ、連絡先データ、コントロールの作成者に関する詳細、またはコントロールの目的の概要を提供できます。

注意

通常、プロパティを TitleUrl 使用してヘルプコンテンツにリンクすることはしません。コントロールのヘルプへのリンクを提供する最善の方法は、プロパティを HelpUrl 使用することです。

適用対象

次の方法で共有

IWebPart.TitleUrl プロパティ

定義

プロパティ値

例

注釈

適用対象

こちらもご覧ください

その他のリソース