次の方法で共有


IWebPart.Description プロパティ

定義

WebPart コントロールのツールヒントやカタログで使用する、コントロールの動作をまとめた短い語句を取得または設定します。

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

プロパティ値

コントロールの機能を簡潔にまとめた文字列。 既定値は空の文字列 ("") です。

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

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

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

    return (string)objTitle;
  }
  set
  {
    ViewState["Description"] = value;
  }
}
Public Property Description() As String _
  Implements IWebPart.Description
  Get
    Dim objTitle As Object = ViewState("Description")
    If objTitle Is Nothing Then
      Return String.Empty
    End If
    Return CStr(objTitle)
  End Get
  Set(ByVal value As String)
    ViewState("Description") = value
  End Set
End Property

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

重要

この例には、ユーザー入力を受け付けるテキスト ボックスがあります。これにより、セキュリティが脆弱になる可能性があります。 既定では、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 対してプロパティを Description 宣言的に設定する方法を示します。 ブラウザーにページを読み込んだ後、コントロールのタイトル バーのタイトル テキストの上にマウス ポインターを置くと、このプロパティの値を確認できます。 また、Web ページを読み込み、指定されたユーザー インターフェイス (UI) を使用してプロパティ値を変更することで、実行時にプロパティ値をプログラムで変更することもできます。

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

注釈

プロパティ値 Description は、通常、コントロールのリストを提供するカタログ内のコントロールの説明文字列として、およびコントロールの WebPart タイトル バーのツールヒントとして使用されます。 プロパティの内容は、ユーザーがコントロールのタイトル バーのタイトル テキストの上にマウス ポインターを置くと、ツールヒントに表示されます。

適用対象

こちらもご覧ください