IWebPart.Description プロパティとは何？わかりやすく解説 Weblio辞書

すべての辞書から再検索する

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

IWebPart.Description プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Property Description As String

Visual Basic (使用法)

Dim instance As IWebPart
Dim value As String

value = instance.Description

instance.Description = value

string Description { get; set;
 }

C++

property String^ Description {
    String^ get ();
    void set (String^ value);
}

/** @property */
String get_Description ()

/** @property */
void set_Description (String value)

JScript

function get Description () : String

function set Description (value : String)

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

解説

使用例

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

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

Visual Basic

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

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

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

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

Visual Basic

' 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

// 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;
  }
}

コード例の 3 番目の部分は、IWebPart インターフェイスを実装するユーザーコントロールを WebPartZone コントロールから参照する方法と、コントロールに対して Description プロパティを宣言によって設定する方法を示しています。ブラウザにページを読み込んだ後、マウスポインタをコントロールのタイトルバーのタイトルテキスト上に移動すると、このプロパティの値を確認できます。また、Web ページを読み込み、表示されるユーザーインターフェイス (UI) を使用してプロパティ値を変更することによって、実行時にプログラムによってプロパティ値が変更されるのを確認できます。

Visual Basic

<%@ page language="VB" %>
<%@ register tagprefix="uc1" 
    tagname="AccountUserControlVB" 
    src="AccountUserControlvb.ascx"%>
<html>
  <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>

<%@ page language="c#" %>
<%@ register tagprefix="uc1" 
    tagname="AccountUserControlCS" 
    src="AccountUserControlcs.ascx"%>
<html>
  <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>

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
IWebPart インターフェイス
IWebPart メンバ
System.Web.UI.WebControls.WebParts 名前空間
Description
Description
GenericWebPart.Description プロパティ
その他の技術情報
ASP.NET Web パーツページ

このページでは「.NET Framework クラスライブラリリファレンス」からIWebPart.Description プロパティを検索した結果を表示しています。
Weblioに収録されているすべての辞書からIWebPart.Description プロパティを検索する場合は、下記のリンクをクリックしてください。

全ての辞書からIWebPart.Description プロパティを検索

>> 「IWebPart.Description プロパティ」を含む用語の索引
IWebPart.Description プロパティのページへのリンク

IWebPart.Description プロパティとは？わかりやすく解説

IWebPart.Description プロパティ

「IWebPart.Description プロパティ」の関連用語


	© 2025 Microsoft.All rights reserved.

IWebPart.Description プロパティとは？ わかりやすく解説

IWebPart.Description プロパティ

急上昇のことば

「IWebPart.Description プロパティ」の関連用語

IWebPart.Description プロパティとは？わかりやすく解説