Aracılığıyla paylaş

IWebPart.Description Özellik

  • Başvuru

Tanım

Ad Alanı:
System.Web.UI.WebControls.WebParts
Bütünleştirilmiş Kod:
System.Web.dll

Araç İpuçlarında ve denetim kataloglarında kullanmak üzere bir denetimin WebPart ne yaptığını özetleyen kısa bir tümcecik alır veya ayarlar.

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

Özellik Değeri

String

Denetimin işlevselliğini kısaca özetleyen bir dize. Varsayılan değer boş bir dizedir ("").

Örnekler

Aşağıdaki kod örneği, özelliğinin bildirim temelli ve programlı kullanımını Description gösterir. Örneğin tam kaynak kodu, sınıfa genel bakışın IWebPart Örnek bölümünde bulunur.

Kod örneğinin ilk bölümünde, kullanıcı denetiminin özelliği nasıl uyguladığı Description gösterilir.

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

Kod örneğinin ikinci bölümünde, kullanıcı sayfadaki radyo düğmelerinden uygun özellik adını seçtiğinde, metin kutusunda yeni bir değer ayarlayıp Güncelleştir düğmesine tıkladığında program aracılığıyla özelliğin değerini Description ayarlayan kullanıcı denetimindeki yöntemi gösterilir.

Önemli

Bu örnekte, olası bir güvenlik tehdidi olan kullanıcı girişini kabul eden bir metin kutusu vardır. Varsayılan olarak, ASP.NET Web sayfaları kullanıcı girişinin betik veya HTML öğeleri içermediğini doğrular. Daha fazla bilgi için bkz. Betik Açıklarına Genel Bakış.

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

Kod örneğinin üçüncü bölümü, arabirimi uygulayan kullanıcı denetimine IWebPart bir WebPartZone denetimde nasıl başvurulduğunu ve özelliğin Description denetimde bildirim temelli olarak nasıl ayarlandığını gösterir. Sayfayı bir tarayıcıya yükledikten sonra fare işaretçinizi denetimin başlık çubuğundaki başlık metninin üzerine yerleştirerek bu özelliğin değerini görebileceğinizi unutmayın. Ayrıca, Web sayfasını yükleyerek ve özellik değerini değiştirmek için sağlanan kullanıcı arabirimini (UI) kullanarak çalışma zamanında özellik değerini program aracılığıyla değiştirmeyi deneyebilirsiniz.

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

Açıklamalar

Özellik Description değeri genellikle denetim listeleri sağlayan kataloglardaki bir denetim için açıklayıcı bir dize olarak ve denetimin WebPart başlık çubuğunda araç ipucu olarak kullanılır. Kullanıcı fare işaretçisini denetimin başlık çubuğundaki başlık metninin üzerine getirince özelliğin içeriği Araç İpucu'nda görünür.

Şunlara uygulanır

Ayrıca bkz.