IWebPart.Description 속성

참조

정의

네임스페이스:: System.Web.UI.WebControls.WebParts

어셈블리:: System.Web.dll

중요

일부 정보는 릴리스되기 전에 상당 부분 수정될 수 있는 시험판 제품과 관련이 있습니다. Microsoft는 여기에 제공된 정보에 대해 어떠한 명시적이거나 묵시적인 보증도 하지 않습니다.

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

속성 값

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

코드 예제의 두 번째 부분은 사용자가 페이지의 라디오 단추에서 적절한 속성 이름을 선택하고 텍스트 상자에 새 값을 설정한 다음 업데이트 단추를 클릭할 때 속성 값을 Description 프로그래밍 방식으로 설정하는 사용자 컨트롤의 메서드를 보여 줍니다.

중요

이 예제에는 사용자 입력을 허용하는 텍스트 상자가 있으므로 보안상 위험할 수 있습니다. 기본적으로 ASP.NET 웹 페이지는 사용자 입력 내용에 스크립트 또는 HTML 요소가 포함되어 있지 않은지 확인합니다. 자세한 내용은 Script Exploits Overview를 참조하세요.

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

코드 예제의 세 번째 부분은 인터페이스를 구현 IWebPart 하는 사용자 컨트롤이 컨트롤에서 참조되는 방법과 컨트롤에서 WebPartZone 속성이 선언적으로 설정되는 방법을 Description 보여 줍니다. 브라우저에서 페이지를 로드한 후 컨트롤의 제목 표시줄에 있는 제목 텍스트 위에 마우스 포인터를 배치하여 이 속성의 값을 볼 수 있습니다. 또한 웹 페이지를 로드하고 제공된 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 컨트롤에 대한 설명 문자열로 사용되며 컨트롤의 제목 표시줄에서 도구 설명으로 사용됩니다. 사용자가 컨트롤의 제목 표시줄에서 제목 텍스트 위에 마우스 포인터를 놓으면 속성의 내용이 도구 설명에 표시됩니다.

적용 대상

IWebPart.Description 속성

정의

속성 값

예제

설명

적용 대상

추가 정보

피드백

추가 리소스