Part.Description プロパティ

定義

パーツ コントロールのツールヒントやカタログで使用する、パーツ コントロールの動作をまとめた短い語句を取得または設定します。Gets or sets a brief phrase that summarizes what the part control does, for use in ToolTips and catalogs of part controls.

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

プロパティ値

パーツ コントロールの機能を簡潔にまとめた文字列。A string that briefly summarizes the part control's functionality. 既定値は、空の文字列 ("") です。The default value is an empty string ("").

次のコード例は、パーツコントロールのDescriptionプロパティの宣言型の使用方法を示しています。The following code example illustrates the declarative use of the Description property in a part control. この例では、 WebPartカスタムTextDisplayWebPartコントロールが必要です。これは、 Partクラスの概要の「例」セクションにあります。This example requires the custom WebPart control TextDisplayWebPart, which can be found in the Example section of the Part class summary.

ブラウザーにページを読み込むと、最初のコントロールインスタンスのタイトルテキストの上にマウスポインターを置くと、ツールヒントに説明のテキストが表示されます。After you load the page in a browser, if you position your mouse pointer over the title text of the first control instance, the description text appears in a ToolTip.

<%@ 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"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            Description="A text content WebPart control."
            ChromeType="TitleAndBorder"
            width="350px" />
        </zonetemplate>
    </asp:webpartzone>
    <asp:webpartzone
      id="WebPartZone2"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart2" 
            title = "Text Content WebPart 2" 
            Description="A text content WebPart control."
            ChromeType="TitleOnly"
            ChromeState="Minimized"
            width="350px" />
        </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"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            Description="A text content WebPart control."
            ChromeType="TitleAndBorder"
            width="350px" />
        </zonetemplate>
    </asp:webpartzone>
    <asp:webpartzone
      id="WebPartZone2"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart2" 
            title = "Text Content WebPart 2" 
            Description="A text content WebPart control."
            ChromeType="TitleOnly"
            ChromeState="Minimized"
            width="350px" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

注釈

Descriptionプロパティは通常、パーツコントロールのリストを提供するカタログで使用される文字列であり、パーツコントロールのタイトルバーのツールヒントとして使用されます。The Description property is typically a string that is used in catalogs that provide lists of part controls, and as a ToolTip in the part control's title bar. パーツコントロールのタイトルDescriptionバーのタイトルテキストの上にマウスポインターを置くと、の内容がツールヒントに表示されます。The content of the Description appears in a ToolTip when you position your mouse pointer over the title text in a part control's title bar. ツールヒントのテキストは、 DisplayTitleプロパティの値の後にハイフン、その後Descriptionにプロパティ値を指定して作成されます。The ToolTip text is created from the value of the DisplayTitle property, followed by a hyphen, followed by the Description property value.

このプロパティの値は、設定されると、デザイナーツールを使用してリソースファイルに自動的に保存できます。The value of this property, when set, can be saved automatically to a resource file by using a designer tool. 詳細についてはLocalizableAttribute 、「」および「グローバリゼーションとローカリゼーション」を参照してください。For more information, see LocalizableAttribute and Globalization and Localization.

注意 (継承者)

などの派生クラスWebPartは、 Descriptionコントロールの説明をユーザーがパーソナル化できるようにオーバーライドできます。Derived classes such as WebPart can override Description to enable user personalization of the control's description.

適用対象

こちらもご覧ください