WebPart.Subtitle Eigenschaft
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
public:
virtual property System::String ^ Subtitle { System::String ^ get(); };
[System.ComponentModel.Browsable(false)]
public virtual string Subtitle { get; }
[<System.ComponentModel.Browsable(false)>]
member this.Subtitle : string
Public Overridable ReadOnly Property Subtitle As String
Eigenschaftswert
Eine Zeichenfolge, die als Untertitel für das Steuerelement fungiert. Der Standardwert ist eine leere Zeichenfolge ("").
Implementiert
- Attribute
Beispiele
Im folgenden Codebeispiel wird veranschaulicht, wie Sie einen Untertitel für Instanzen eines benutzerdefinierten WebPart Steuerelements bereitstellen.
Der erste Teil dieses Beispiels enthält den Code für ein benutzerdefiniertes Steuerelement namens TextDisplayWebPart
. Dieses Steuerelement ist identisch mit dem benutzerdefinierten Steuerelement, das im Beispielabschnitt der WebPart Klassenübersicht gefunden wird, außer dass es auch die Subtitle Eigenschaft außer Kraft setzt, um einen Standarduntertitel bereitzustellen, der einen fiktiven Firmennamen für Instanzen des benutzerdefinierten Steuerelements enthält. Damit das Codebeispiel ausgeführt werden kann, müssen Sie diesen Quellcode kompilieren. Sie können es explizit kompilieren und die resultierende Assembly im Ordner "Bin" ihrer Website oder im globalen Assemblycache platzieren. Alternativ können Sie den Quellcode in den App_Code Ordner Ihrer Website einfügen, in dem sie zur Laufzeit dynamisch kompiliert wird. In diesem Codebeispiel wird davon ausgegangen, dass Sie den Quellcode in eine Assembly kompilieren, sie in einem Bin-Unterordner Ihrer Webanwendung platzieren und auf die Assembly mit einer Register
Direktive in Ihrer Webseite verweisen. Eine exemplarische Vorgehensweise, die beide Methoden der Kompilierung veranschaulicht, finden Sie unter Walkthrough: Developing and Using a Custom Web Server Control.
using System;
using System.Security.Permissions;
using System.Web;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
namespace Samples.AspNet.CS.Controls
{
[AspNetHostingPermission(SecurityAction.Demand,
Level=AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level=AspNetHostingPermissionLevel.Minimal)]
public class TextDisplayWebPart : WebPart
{
private String _contentText = null;
TextBox input;
Label DisplayContent;
const string _subTitle = "Contoso, Ltd";
public TextDisplayWebPart()
{
this.AllowClose = false;
}
[Personalizable(), WebBrowsable]
public String ContentText
{
get { return _contentText; }
set { _contentText = value; }
}
protected override void CreateChildControls()
{
Controls.Clear();
DisplayContent = new Label();
DisplayContent.BackColor =
System.Drawing.Color.LightBlue;
DisplayContent.Text = this.ContentText;
this.Controls.Add(DisplayContent);
input = new TextBox();
this.Controls.Add(input);
Button update = new Button();
update.Text = "Set Label Content";
update.Click += new EventHandler(this.submit_Click);
this.Controls.Add(update);
ChildControlsCreated = true;
}
public override string Subtitle
{
get {return _subTitle; }
}
private void submit_Click(object sender, EventArgs e)
{
// Update the label string.
if (!string.IsNullOrEmpty(input.Text))
{
_contentText = input.Text + @"<br />";
input.Text = String.Empty;
DisplayContent.Text = this.ContentText;
}
}
}
}
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Namespace Samples.AspNet.VB.Controls
<AspNetHostingPermission(SecurityAction.Demand, _
Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class TextDisplayWebPart
Inherits WebPart
Private _contentText As String = Nothing
Private input As TextBox
Private DisplayContent As Label
Private Const _subTitle as String = "Contoso, Ltd"
Public Sub New()
Me.AllowClose = False
End Sub
<Personalizable(), WebBrowsable()> _
Public Property ContentText() As String
Get
Return _contentText
End Get
Set
_contentText = value
End Set
End Property
Protected Overrides Sub CreateChildControls()
Controls.Clear()
DisplayContent = New Label()
DisplayContent.Text = Me.ContentText
DisplayContent.BackColor = _
System.Drawing.Color.LightBlue
Me.Controls.Add(DisplayContent)
input = New TextBox()
Me.Controls.Add(input)
Dim update As New Button()
update.Text = "Set Label Content"
AddHandler update.Click, AddressOf Me.submit_Click
Me.Controls.Add(update)
ChildControlsCreated = True
End Sub
Public Overrides ReadOnly Property Subtitle() As String
Get
Return _subTitle
End Get
End Property
Private Sub submit_Click(ByVal sender As Object, _
ByVal e As EventArgs)
' Update the label string.
If input.Text <> String.Empty Then
_contentText = input.Text & "<br />"
input.Text = String.Empty
DisplayContent.Text = Me.ContentText
End If
End Sub
End Class
End Namespace
Der zweite Teil des Beispiels ist eine Webseite, die zeigt, wie auf das TextDisplayWebPart
Steuerelement in einer ASP.NET Webseite verwiesen wird. Nachdem Sie die Seite in einem Browser geladen haben, enthält der Titelleistentext des Steuerelements den Titel des Steuerelements im deklarativen Markup, ein Trennzeichen und den Wert des benutzerdefinierten Untertitels aus dem TextDisplayWebPart
Steuerelement.
<%@ page language="C#" %>
<%@ register tagprefix="aspSample"
Namespace="Samples.AspNet.CS.Controls"
Assembly="TextDisplayWebPartCS"%>
<!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 id="Head1" runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="Form1" runat="server">
<asp:webpartmanager id="WebPartManager1" runat="server" />
<asp:webpartzone
id="WebPartZone1"
runat="server"
title="Zone 1"
PartChromeType="TitleAndBorder">
<parttitlestyle font-bold="true" ForeColor="#3300cc" />
<partstyle
borderwidth="1px"
borderstyle="Solid"
bordercolor="#81AAF2" />
<zonetemplate>
<aspSample:TextDisplayWebPart
runat="server"
id="textwebpart"
title = "Text WebPart"
/>
</zonetemplate>
</asp:webpartzone>
</form>
</body>
</html>
<%@ page language="VB" %>
<%@ register tagprefix="aspSample"
Namespace="Samples.AspNet.VB.Controls"
Assembly="TextDisplayWebPartVB"%>
<!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 id="Head1" runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="Form1" runat="server">
<asp:webpartmanager id="WebPartManager1" runat="server" />
<asp:webpartzone
id="WebPartZone1"
runat="server"
title="Zone 1"
PartChromeType="TitleAndBorder">
<parttitlestyle font-bold="true" ForeColor="#3300cc" />
<partstyle
borderwidth="1px"
borderstyle="Solid"
bordercolor="#81AAF2" />
<zonetemplate>
<aspSample:TextDisplayWebPart
runat="server"
id="textwebpart"
title = "Text WebPart"
/>
</zonetemplate>
</asp:webpartzone>
</form>
</body>
</html>
Hinweise
Verwenden Sie die Subtitle Eigenschaft optional, um eine standardmäßige Untertitelzeichenfolge in Ihrem benutzerdefinierten WebPart Steuerelement zurückzugeben, das an den Titel des Steuerelements angefügt wird.
Wenn Sie einen Wert für die Subtitle Eigenschaft in einem benutzerdefinierten WebPart Steuerelement angeben, fügt das Webparts-Steuerelement automatisch an den Wert der Title Eigenschaft an, um einen vollständigen Titel für das Steuerelement zu erstellen.
Der Wert dieser Eigenschaft, wenn festgelegt, kann mithilfe eines Designers Tools automatisch zu einer Ressourcendatei gespeichert werden. Weitere Informationen finden Sie unter LocalizableAttribute und Globalisierung und Lokalisierung.
Hinweise für Vererber
Um einen Untertitel für Instanzen eines benutzerdefinierten WebPart Steuerelements anzugeben, müssen Sie die Subtitle Eigenschaft außer Kraft setzen.