IWebPart.Description Eigenschap
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Hiermee haalt u een korte woordgroep op die samenvat wat een besturingselement doet, voor gebruik in Knopinfo en catalogi van WebPart besturingselementen.
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 StringWaarde van eigenschap
Een tekenreeks die de functionaliteit van het besturingselement kort samenvat. De standaardwaarde is een lege tekenreeks ("").
Voorbeelden
In het volgende codevoorbeeld ziet u het declaratieve en programmatische gebruik van de Description eigenschap. De volledige broncode voor het voorbeeld vindt u in de sectie Voorbeeld van het IWebPart klassenoverzicht.
In het eerste deel van het codevoorbeeld ziet u hoe het gebruikersbesturingselement de Description eigenschap implementeert.
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
In het tweede deel van het codevoorbeeld ziet u de methode in het gebruikersbesturingselement waarmee de waarde van de Description eigenschap via een programma wordt ingesteld wanneer een gebruiker de juiste eigenschapsnaam selecteert in de keuzerondjes op de pagina, een nieuwe waarde instelt in het tekstvak en vervolgens op de knop Bijwerken klikt.
Important
Dit voorbeeld heeft een tekstvak dat gebruikersinvoer accepteert. Dit is een mogelijke beveiligingsrisico. Standaard valideren ASP.NET webpagina's dat gebruikersinvoer geen script- of HTML-elementen bevat. Zie Overzicht van Script Exploits voor meer informatie.
// 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
Het derde deel van het codevoorbeeld laat zien hoe het gebruikersbesturingselement dat de IWebPart interface implementeert, wordt verwezen in een WebPartZone besturingselement en hoe de Description eigenschap declaratief wordt ingesteld op het besturingselement. Houd er rekening mee dat u de waarde van deze eigenschap kunt zien door de muisaanwijzer op de titeltekst in de titelbalk van het besturingselement te plaatsen nadat u de pagina in een browser hebt geladen. U kunt ook experimenteren met het programmatisch wijzigen van de eigenschapswaarde tijdens runtime door de webpagina te laden en de opgegeven gebruikersinterface (UI) te gebruiken om de eigenschapswaarde te wijzigen.
<%@ 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>
Opmerkingen
De Description eigenschapswaarde wordt doorgaans gebruikt als een beschrijvende tekenreeks voor een besturingselement in catalogi die lijsten met besturingselementen bevatten en als knopinfo op de titelbalk van WebPart een besturingselement. De inhoud van de eigenschap wordt weergegeven in knopinfo wanneer een gebruiker de muisaanwijzer boven de titeltekst in de titelbalk van een besturingselement plaatst.
