GenericWebPart.Description 속성

정의

네임스페이스:

System.Web.UI.WebControls.WebParts

어셈블리:

System.Web.dll

서버 컨트롤의 도구 설명과 카탈로그에 사용하기 위해 컨트롤의 용도를 요약한 간략한 문구를 가져오거나 설정합니다.

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

public override string Description { get; set; }

member this.Description : string with get, set

Public Overrides Property Description As String

속성 값

String

컨트롤의 기능을 간략하게 요약한 문자열입니다. 기본값은 빈 문자열("")입니다.

예제

다음 코드 예제에서는 선언적 및 프로그래밍 방식으로 사용 하는 Description 속성입니다. 예제의 전체 소스 코드는 개요 항목의 예제 섹션에 있습니다 GenericWebPart .

코드 예제의 첫 번째 부분은 속성이 컨트롤 내 WebPartZone 의 Description 서버 컨트롤에서 선언적으로 설정되는 방법을 보여줍니다.

<asp:WebPartZone ID="WebPartZone1" runat="server">
  <ZoneTemplate>
    <asp:Calendar ID="Calendar1" runat="server"
      Title="My Calendar"
      Description="A calendar used as a GenericWebPart control."
      CatalogIconImageUrl="MyCatalogIcon.gif"
      TitleIconimageUrl ="MyTitleIcon.gif"
      TitleUrl="MyInfoUrl.htm" 
      Width="250"/>
  </ZoneTemplate>
</asp:WebPartZone>

<asp:WebPartZone ID="WebPartZone1" runat="server">
  <ZoneTemplate>
    <asp:Calendar ID="Calendar1" runat="server"
      Title="My Calendar"
      Description="A calendar used as a GenericWebPart control."
      CatalogIconImageUrl="MyCatalogIcon.gif"
      TitleIconimageUrl ="MyTitleIcon.gif"
      TitleUrl="MyInfoUrl.htm" 
      Width="250"/>
  </ZoneTemplate>
</asp:WebPartZone>

코드 예제의 두 번째 부분에서 액세스 하는 방법에 설명 합니다 속성 레이블에 해당 값을 표시 하는 프로그래밍 방식으로 합니다.

protected void Button1_Click(object sender, EventArgs e)
{

  Label2.Text =
    @"<h3>Calendar GenericWebPart Properties</h3>" +
    "<em>Title: </em>" + calendarPart.Title +
    "<br />" +
    "<em>CatalogIconImageUrl:  </em>" + calendarPart.CatalogIconImageUrl +
    "<br />" +
    "<em>TitleUrl: </em>" + calendarPart.TitleUrl +
    "<br />" +
    "<em>Decription: </em>" + calendarPart.Description +
    "<br />" +
    "<em>TitleIconImageUrl: </em>" + calendarPart.TitleIconImageUrl +
    "<br />" +
    "<em>ChildControl ID: </em>" + calendarPart.ChildControl.ID +
    "<br />" +
    "<em>ChildControl Type: </em>" + calendarPart.ChildControl.GetType().Name +
    "<br />" +
    "<em>GenericWebPart ID: </em>" + calendarPart.ID +
    "<br />" +
    "<em>GenericWebPart Type: </em>" + calendarPart.GetType().Name +
    "<br />" +
    "<em>GenericWebPart Parent ID: </em>" + calendarPart.Parent.ID;

  Label3.Text =
    @"<h3>BulletedList GenericWebPart Properties</h3>" +
    "<em>Title: </em>" + listPart.Title +
    "<br />" +
    "<em>CatalogIconImageUrl:  </em>" + listPart.CatalogIconImageUrl +
    "<br />" +
    "<em>TitleUrl: </em>" + listPart.TitleUrl +
    "<br />" +
    "<em>Decription: </em>" + listPart.Description +
    "<br />" +
    "<em>TitleIconImageUrl: </em>" + listPart.TitleIconImageUrl +
    "<br />" +
    "<em>ChildControl ID: </em>" + listPart.ChildControl.ID +
    "<br />" +
    "<em>ChildControl Type: </em>" + listPart.ChildControl.GetType().Name +
    "<br />" +
    "<em>GenericWebPart ID: </em>" + listPart.ID +
    "<br />" +
    "<em>GenericWebPart Type: </em>" + listPart.GetType().Name +
    "<br />" +
    "<em>GenericWebPart Parent ID: </em>" + listPart.Parent.ID;
}

  Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)

    Label2.Text = _
      "<h3>Calendar GenericWebPart Properties</h3>" & _
      "<em>Title: </em>" & calendarPart.Title & _
      "<br />" & _
      "<em>CatalogIconImageUrl:  </em>" & calendarPart.CatalogIconImageUrl & _
      "<br />" & _
      "<em>TitleUrl: </em>" & calendarPart.TitleUrl & _
      "<br />" & _
      "<em>Decription: </em>" & calendarPart.Description & _
      "<br />" & _
      "<em>TitleIconImageUrl: </em>" & calendarPart.TitleIconImageUrl & _
      "<br />" & _
      "<em>ChildControl ID: </em>" & calendarPart.ChildControl.ID & _
      "<br />" & _
      "<em>ChildControl Type: </em>" & calendarPart.ChildControl.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart ID: </em>" & calendarPart.ID & _
      "<br />" & _
      "<em>GenericWebPart Type: </em>" & calendarPart.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart Parent ID: </em>" & calendarPart.Parent.ID

    Label3.Text = _
      "<h3>BulletedList GenericWebPart Properties</h3>" & _
      "<em>Title: </em>" & listPart.Title & _
      "<br />" & _
      "<em>CatalogIconImageUrl:  </em>" & listPart.CatalogIconImageUrl & _
      "<br />" & _
      "<em>TitleUrl: </em>" & listPart.TitleUrl & _
      "<br />" & _
      "<em>Decription: </em>" & listPart.Description & _
      "<br />" & _
      "<em>TitleIconImageUrl: </em>" & listPart.TitleIconImageUrl & _
      "<br />" & _
      "<em>ChildControl ID: </em>" & listPart.ChildControl.ID & _
      "<br />" & _
      "<em>ChildControl Type: </em>" & listPart.ChildControl.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart ID: </em>" & listPart.ID & _
      "<br />" & _
      "<em>GenericWebPart Type: </em>" & listPart.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart Parent ID: </em>" & listPart.Parent.ID
  End Sub

End Class

설명

속성 값은 Description 일반적으로 서버 컨트롤 목록을 제공하는 카탈로그의 컨트롤에 대한 설명 문자열로 사용되며 컨트롤의 제목 표시줄에 도구 설명으로 사용됩니다. 사용자가 컨트롤의 제목 표시줄에서 제목 텍스트 위에 마우스 포인터를 놓으면 속성의 콘텐츠가 도구 설명에 표시됩니다.

이 속성은 자식 컨트롤의 속성에 실제 WebPart 컨트롤인 것처럼 액세스할 수 있도록 기본 속성을 재정의합니다.

웹 페이지의 선언적 태그뿐만 아니라 프로그래밍 방식으로 컨트롤의 속성 값을 설정할 수 있습니다. 컨트롤을 사용할 때마다 속성에 대한 기본값을 제공하려면 인터페이스를 구현할 IWebPart 수 있습니다.

추가 정보

• 웹 파트 컨트롤 ASP.NET