IWebPart.Description Właściwość
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Pobiera lub ustawia krótką frazę, która podsumowuje działanie kontrolki do użycia w etykietkach narzędzi i katalogach WebPart kontrolek.
public:
property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };public string Description { get; set; }member this.Description : string with get, setPublic Property Description As StringWartość właściwości
Ciąg, który krótko podsumowuje funkcjonalność kontrolki. Wartością domyślną jest ciąg pusty ("").
Przykłady
Poniższy przykład kodu przedstawia deklaratywne i programowe użycie Description właściwości. Kompletny kod źródłowy przykładu znajduje się w sekcji IWebPart Przykład przeglądu klasy.
Pierwsza część przykładu kodu pokazuje, jak kontrolka użytkownika implementuje Description właściwość.
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
Druga część przykładu kodu pokazuje metodę w kontrolce użytkownika, która programowo ustawia wartość Description właściwości, gdy użytkownik wybiera odpowiednią nazwę właściwości z przycisków radiowych na stronie, ustawia nową wartość w polu tekstowym, a następnie klika przycisk Aktualizuj .
Ważne
W tym przykładzie znajduje się pole tekstowe, które akceptuje dane wejściowe użytkownika, co jest potencjalnym zagrożeniem bezpieczeństwa. Domyślnie ASP.NET strony sieci Web weryfikują, czy dane wejściowe użytkownika nie zawierają skryptów ani elementów HTML. Aby uzyskać więcej informacji, zobacz Omówienie luk w zabezpieczeniach skryptów.
// 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
Trzecia część przykładu kodu pokazuje, w jaki sposób kontrolka użytkownika, która implementuje IWebPart interfejs, jest przywołyny w kontrolce WebPartZone i jak Description właściwość jest ustawiana deklaratywnie na kontrolce. Należy pamiętać, że wartość tej właściwości można wyświetlić, ustawiając wskaźnik myszy nad tekstem tytułu na pasku tytułu kontrolki po załadowaniu strony w przeglądarce. Możesz również eksperymentować ze zmianą wartości właściwości programowo w czasie wykonywania, ładując stronę internetową i używając podanego interfejsu użytkownika (UI), aby zmienić wartość właściwości.
<%@ 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>
Uwagi
Description Wartość właściwości jest zwykle używana jako ciąg opisowy dla kontrolki w wykazach, które udostępniają listy WebPart kontrolek i jako etykietkę narzędzia na pasku tytułu kontrolki. Zawartość właściwości jest wyświetlana w etykietce narzędzia, gdy użytkownik umieszcza wskaźnik myszy nad tekstem tytułu na pasku tytułu kontrolki.
