EditorPart 類別
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
作為位於 EditorZoneBase 區域中控制項的基底類別,且用來編輯 WebPart 控制項。
public ref class EditorPart abstract : System::Web::UI::WebControls::WebParts::Part
[System.ComponentModel.Bindable(false)]
public abstract class EditorPart : System.Web.UI.WebControls.WebParts.Part
[<System.ComponentModel.Bindable(false)>]
type EditorPart = class
inherit Part
Public MustInherit Class EditorPart
Inherits Part
- 繼承
- 衍生
- 屬性
範例
下列程式碼範例示範控制項的 EditorPart 宣告式和程式設計用法。 此程式碼範例有四個部分:
使用者控制項,可讓您變更網頁元件頁面上的顯示模式。
包含 EditorZone 控制項的網頁,其中包含區域中宣告之 Web 元件控制項集中的數 EditorPart 個控制項,以及自訂 WebPart 控制項的參考。
類別,其中包含自訂 WebPart 控制項,以及用於編輯 控制項中屬性的 WebPart 自訂 EditorPart 控制項。
說明當您在瀏覽器中載入頁面時,此範例的運作方式。
此程式碼範例的第一個部分是使用者控制項,可讓使用者變更網頁上的顯示模式。 如需此控制項中顯示模式和原始程式碼描述的詳細資訊,請參閱逐步解說 :變更網頁元件頁面上的顯示模式。
<%@ control language="C#" classname="DisplayModeMenuCS"%>
<script runat="server">
// Use a field to reference the current WebPartManager.
WebPartManager _manager;
void Page_Init(object sender, EventArgs e)
{
Page.InitComplete += new EventHandler(InitComplete);
}
void InitComplete(object sender, System.EventArgs e)
{
_manager = WebPartManager.GetCurrentWebPartManager(Page);
String browseModeName = WebPartManager.BrowseDisplayMode.Name;
// Fill the dropdown with the names of supported display modes.
foreach (WebPartDisplayMode mode in _manager.SupportedDisplayModes)
{
String modeName = mode.Name;
// Make sure a mode is enabled before adding it.
if (mode.IsEnabled(_manager))
{
ListItem item = new ListItem(modeName + " Mode", modeName);
DisplayModeDropdown.Items.Add(item);
}
}
}
// Change the page to the selected display mode.
void DisplayModeDropdown_SelectedIndexChanged(object sender,
EventArgs e)
{
String selectedMode = DisplayModeDropdown.SelectedValue;
WebPartDisplayMode mode = _manager.SupportedDisplayModes[selectedMode];
if (mode != null)
_manager.DisplayMode = mode;
}
void Page_PreRender(object sender, EventArgs e)
{
DisplayModeDropdown.SelectedValue = _manager.DisplayMode.Name;
}
</script>
<div>
<asp:DropDownList ID="DisplayModeDropdown"
runat="server"
AutoPostBack="true"
OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
</div>
<%@ control language="vb" classname="DisplayModeMenuVB"%>
<script runat="server">
' Use a field to reference the current WebPartManager.
Dim _manager As WebPartManager
Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs)
AddHandler Page.InitComplete, AddressOf InitComplete
End Sub
Sub InitComplete(ByVal sender As Object, ByVal e As System.EventArgs)
_manager = WebPartManager.GetCurrentWebPartManager(Page)
Dim browseModeName As String = WebPartManager.BrowseDisplayMode.Name
' Fill the dropdown with the names of supported display modes.
Dim mode As WebPartDisplayMode
For Each mode In _manager.SupportedDisplayModes
Dim modeName As String = mode.Name
' Make sure a mode is enabled before adding it.
If mode.IsEnabled(_manager) Then
Dim item As New ListItem(modeName + " Mode", modeName)
DisplayModeDropdown.Items.Add(item)
End If
Next mode
End Sub
' Change the page to the selected display mode.
Sub DisplayModeDropdown_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs)
Dim selectedMode As String = DisplayModeDropdown.SelectedValue
Dim mode As WebPartDisplayMode = _manager.SupportedDisplayModes(selectedMode)
If Not (mode Is Nothing) Then
_manager.DisplayMode = mode
End If
End Sub
Sub Page_PreRender(ByVal sender As Object, ByVal e As EventArgs)
DisplayModeDropdown.SelectedValue = _manager.DisplayMode.Name
End Sub
</script>
<div>
<asp:DropDownList ID="DisplayModeDropdown"
runat="server"
AutoPostBack="true"
OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
</div>
程式碼範例的第二個部分是網頁。 它包含控制項的 EditorZone 宣告式參考,其中子 <zonetemplate>
元素包含兩個 Web 元件控制項集 EditorPart 控制項的宣告式參考。 頁面也會參考自訂 WebPart 控制項,使用 Register
元件的 指示詞,以及 <aspSample:TextDisplayWebPart>
控制項的 元素。
<%@ page language="c#" %>
<%@ register TagPrefix="uc1"
TagName="DisplayModeMenu"
Src="DisplayModecs.ascx" %>
<%@ 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 runat="server">
<title>
Text Display WebPart with EditorPart
</title>
</head>
<body>
<form id="form1" runat="server">
<asp:webpartmanager id="WebPartManager1" runat="server" />
<uc1:DisplayModeMenu ID="DisplayModeMenu1" runat="server" />
<asp:webpartzone id="zone1" runat="server"
CloseVerb-Enabled="false">
<zonetemplate>
<aspSample:TextDisplayWebPart
runat="server"
id="textwebpart"
title = "Text Content WebPart" />
</zonetemplate>
</asp:webpartzone>
<asp:EditorZone ID="EditorZone1" runat="server">
<ZoneTemplate>
<asp:AppearanceEditorPart ID="AppearanceEditorPart1"
runat="server" />
<asp:LayoutEditorPart ID="LayoutEditorPart1"
runat="server" />
</ZoneTemplate>
</asp:EditorZone>
</form>
</body>
</html>
<%@ page language="vb" %>
<%@ register TagPrefix="uc1"
TagName="DisplayModeMenu"
Src="DisplayModevb.ascx" %>
<%@ 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>
Text Display WebPart with EditorPart
</title>
</head>
<body>
<form id="form1" runat="server">
<asp:webpartmanager id="WebPartManager1" runat="server" />
<uc1:DisplayModeMenu ID="DisplayModeMenu1" runat="server" />
<asp:webpartzone id="zone1" runat="server"
CloseVerb-Enabled="false">
<zonetemplate>
<aspSample:TextDisplayWebPart
runat="server"
id="textwebpart"
title = "Text Content WebPart" />
</zonetemplate>
</asp:webpartzone>
<asp:EditorZone ID="EditorZone1" runat="server">
<ZoneTemplate>
<asp:AppearanceEditorPart ID="AppearanceEditorPart1"
runat="server" />
<asp:LayoutEditorPart ID="LayoutEditorPart1"
runat="server" />
</ZoneTemplate>
</asp:EditorZone>
</form>
</body>
</html>
程式碼範例的第三個部分是名為 TextDisplayWebPart
的自訂 WebPart 類別。 類別會實作 IWebEditable 介面。 在此類別中是巢狀的私用類別,其中包含與 類別相關聯的私 EditorPart 用 TextDisplayWebPart
類別程式碼,並命名為 TextDisplayEditorPart
。 在執行時間,當 TextDisplayWebPart
控制項進入編輯模式時,它會 TextDisplayWebPart.CreateEditorParts
在其 方法中建立 類別的 TextDisplayEditorPart
實例,並將它連同其他 EditorPart 控制項一起顯示在 控制項中 EditorZone 。
using System;
using System.Collections;
using System.ComponentModel;
using System.Drawing;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
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;
private String _fontStyle = null;
TextBox input;
Label DisplayContent;
Literal lineBreak;
public override EditorPartCollection CreateEditorParts()
{
ArrayList editorArray = new ArrayList();
TextDisplayEditorPart edPart = new TextDisplayEditorPart();
edPart.ID = this.ID + "_editorPart1";
editorArray.Add(edPart);
EditorPartCollection editorParts =
new EditorPartCollection(editorArray);
return editorParts;
}
public override object WebBrowsableObject
{
get { return this; }
}
[Personalizable(), WebBrowsable]
public String ContentText
{
get { return _contentText; }
set { _contentText = value; }
}
[Personalizable(), WebBrowsable()]
public String FontStyle
{
get { return _fontStyle; }
set { _fontStyle = value; }
}
protected override void CreateChildControls()
{
Controls.Clear();
DisplayContent = new Label();
DisplayContent.BackColor = Color.LightBlue;
DisplayContent.Text = this.ContentText;
if (FontStyle == null)
FontStyle = "None";
SetFontStyle(DisplayContent, FontStyle);
this.Controls.Add(DisplayContent);
lineBreak = new Literal();
lineBreak.Text = @"<br />";
Controls.Add(lineBreak);
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);
}
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;
}
}
private void SetFontStyle(Label label, String selectedStyle)
{
if (selectedStyle == "Bold")
{
label.Font.Bold = true;
label.Font.Italic = false;
label.Font.Underline = false;
}
else if (selectedStyle == "Italic")
{
label.Font.Italic = true;
label.Font.Bold = false;
label.Font.Underline = false;
}
else if (selectedStyle == "Underline")
{
label.Font.Underline = true;
label.Font.Bold = false;
label.Font.Italic = false;
}
else
{
label.Font.Bold = false;
label.Font.Italic = false;
label.Font.Underline = false;
}
}
// Create a custom EditorPart to edit the WebPart control.
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
private class TextDisplayEditorPart : EditorPart
{
DropDownList _partContentFontStyle;
public TextDisplayEditorPart()
{
Title = "Font Face";
}
public override bool ApplyChanges()
{
TextDisplayWebPart part =
(TextDisplayWebPart)WebPartToEdit;
// Update the custom WebPart control with the font style.
part.FontStyle = PartContentFontStyle.SelectedValue;
return true;
}
public override void SyncChanges()
{
TextDisplayWebPart part =
(TextDisplayWebPart)WebPartToEdit;
String currentStyle = part.FontStyle;
// Select the current font style in the drop-down control.
foreach (ListItem item in PartContentFontStyle.Items)
{
if (item.Value == currentStyle)
{
item.Selected = true;
break;
}
}
}
protected override void CreateChildControls()
{
Controls.Clear();
// Add a set of font styles to the dropdown list.
_partContentFontStyle = new DropDownList();
_partContentFontStyle.Items.Add("Bold");
_partContentFontStyle.Items.Add("Italic");
_partContentFontStyle.Items.Add("Underline");
_partContentFontStyle.Items.Add("None");
Controls.Add(_partContentFontStyle);
}
protected override void RenderContents(HtmlTextWriter writer)
{
writer.Write("<b>Text Content Font Style</b>");
writer.WriteBreak();
writer.Write("Select a font style.");
writer.WriteBreak();
_partContentFontStyle.RenderControl(writer);
writer.WriteBreak();
}
// Access the drop-down control through a property.
private DropDownList PartContentFontStyle
{
get
{
EnsureChildControls();
return _partContentFontStyle;
}
}
}
}
}
Imports System.Collections
Imports System.ComponentModel
Imports System.Drawing
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI
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 _fontStyle As String = Nothing
Private input As TextBox
Private DisplayContent As Label
Private lineBreak As Literal
Public Overrides Function CreateEditorParts() _
As EditorPartCollection
Dim editorArray As New ArrayList()
Dim edPart as New TextDisplayEditorPart()
edPart.ID = Me.ID & "_editorPart1"
editorArray.Add(edPart)
Dim editorParts As New EditorPartCollection(editorArray)
Return editorParts
End Function
Public Overrides ReadOnly Property WebBrowsableObject() _
As Object
Get
Return Me
End Get
End Property
<Personalizable(), WebBrowsable()> _
Public Property ContentText() As String
Get
Return _contentText
End Get
Set(ByVal value As String)
_contentText = Value
End Set
End Property
<Personalizable(), WebBrowsable()> _
Public Property FontStyle() As String
Get
Return _fontStyle
End Get
Set(ByVal value As String)
_fontStyle = Value
End Set
End Property
Protected Overrides Sub CreateChildControls()
Controls.Clear()
DisplayContent = New Label()
DisplayContent.BackColor = Color.LightBlue
DisplayContent.Text = Me.ContentText
If FontStyle Is Nothing Then
FontStyle = "None"
End If
SetFontStyle(DisplayContent, FontStyle)
Me.Controls.Add(DisplayContent)
lineBreak = New Literal()
lineBreak.Text = "<br />"
Controls.Add(lineBreak)
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)
End Sub
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
Private Sub SetFontStyle(ByVal label As Label, _
ByVal selectedStyle As String)
If selectedStyle = "Bold" Then
label.Font.Bold = True
label.Font.Italic = False
label.Font.Underline = False
ElseIf selectedStyle = "Italic" Then
label.Font.Italic = True
label.Font.Bold = False
label.Font.Underline = False
ElseIf selectedStyle = "Underline" Then
label.Font.Underline = True
label.Font.Bold = False
label.Font.Italic = False
Else
label.Font.Bold = False
label.Font.Italic = False
label.Font.Underline = False
End If
End Sub
' Create a custom EditorPart to edit the WebPart control.
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Private Class TextDisplayEditorPart
Inherits EditorPart
Private _partContentFontStyle As DropDownList
Public Sub New()
Title = "Font Face"
End Sub
Public Overrides Function ApplyChanges() As Boolean
Dim part As TextDisplayWebPart = CType(WebPartToEdit, _
TextDisplayWebPart)
' Update the custom WebPart control with the font style.
part.FontStyle = PartContentFontStyle.SelectedValue
Return True
End Function
Public Overrides Sub SyncChanges()
Dim part As TextDisplayWebPart = CType(WebPartToEdit, _
TextDisplayWebPart)
Dim currentStyle As String = part.FontStyle
' Select the current font style in the drop-down control.
Dim item As ListItem
For Each item In PartContentFontStyle.Items
If item.Value = currentStyle Then
item.Selected = True
Exit For
End If
Next item
End Sub
Protected Overrides Sub CreateChildControls()
Controls.Clear()
' Add a set of font styles to the dropdown list.
_partContentFontStyle = New DropDownList()
_partContentFontStyle.Items.Add("Bold")
_partContentFontStyle.Items.Add("Italic")
_partContentFontStyle.Items.Add("Underline")
_partContentFontStyle.Items.Add("None")
Controls.Add(_partContentFontStyle)
End Sub
Protected Overrides Sub RenderContents(ByVal writer _
As HtmlTextWriter)
writer.Write("<b>Text Content Font Style</b>")
writer.WriteBreak()
writer.Write("Select a font style.")
writer.WriteBreak()
_partContentFontStyle.RenderControl(writer)
writer.WriteBreak()
End Sub
' Access the drop-down control through a property.
Private ReadOnly Property PartContentFontStyle() As DropDownList
Get
EnsureChildControls()
Return _partContentFontStyle
End Get
End Property
End Class
End Class
End Namespace
在瀏覽器中載入頁面,然後在 [顯示模式 ] 控制項上,選取 [ 編輯模式 ] 以切換至編輯模式。 按一下動詞功能表 (控制項標題列中 TextDisplayWebPart
的向下箭號) ,然後按一下 [編輯 ] 以編輯控制項。 當編輯 UI 可見時,您可以看到三 EditorPart 個控制項,包括可讓您編輯屬性的 TextDisplayWebPart.FontStyle
自訂控制項。 如果您在編輯 UI 中進行一些變更,然後按一下 [ 套 用] 按鈕,您可以使用下拉式清單控制項傳回頁面以瀏覽模式,並查看編輯變更的完整效果。
備註
類別 EditorPart 提供一組基底屬性和方法,這些屬性和方法是由 Web 元件控制項集和自訂 EditorPart 控制項所提供的衍生 EditorPart 控制項所使用。 控制項 EditorPart 可讓使用者藉由修改其版面配置、外觀、屬性、行為或其他特性,來編輯相關聯的 WebPart 控制項。
編輯使用者介面 (UI) 是由包含 EditorPart 控制項的區域所組成 EditorZoneBase ,會在網頁進入編輯模式之後顯示。
注意
控制項 EditorPart 只能在衍生自 EditorZoneBase 類別的區域內使用,例如 EditorZone 控制項。
在頁面進入編輯模式之後,使用者可以按一下所選取控制項的動詞功能表上的編輯動詞來選取 WebPart 要編輯的控制項。 一次只能編輯一個 WebPart 控制項。
Web 元件控制項集提供數個衍生 EditorPart 控制項,如下表所列。 這些控制項提供大部分應用程式所需的所有編輯功能。 在網頁元件頁面中使用這些控制項的一般方法是在 元素內 <zonetemplate>
以頁面持續性格式宣告這些控制項,其中 <zonetemplate>
是 專案的 <asp:editorzone>
子項目。 如需程式碼範例,請參閱本主題的一節。
控制項的類型 | 描述 |
---|---|
AppearanceEditorPart | 編輯相關聯控制項的外觀,包括其標題文字、高度、寬度和框線屬性等屬性。 |
BehaviorEditorPart | 編輯相關聯控制項的特定行為,例如是否可以編輯、是否可以關閉或是否可以移至另一個區域。 只有在共用個人化範圍中編輯控制項時,才會在頁面上看到此控制項。 |
LayoutEditorPart | 編輯相關聯控制項的配置屬性,例如它處於正常狀態或最小化 (折迭) 狀態,以及它所在的區域。 |
PropertyGridEditorPart | 如果這些屬性是在原始程式碼 WebBrowsable 中使用 屬性宣告,則編輯相關聯控制項的屬性。 |
注意
為了改善協助工具,Web 元件控制項集中提供的所有 EditorPart 控制項都會在 元素內 <fieldset>
轉譯。 元素會將 <fieldset>
用於在指定 EditorPart 控制項中編輯的相關控制項集分組,並有助於在視覺使用者代理程式 ( (這些控制項之間,例如一般網頁瀏覽器) 和語音導向使用者代理程式, (例如螢幕閱讀軟體) 。
給實施者的注意事項
若要建立自訂 EditorPart 控制項,您必須覆寫兩個重要方法。 方法 ApplyChanges() 會將編輯器控制項中所做的變更套用至要編輯的 WebPart 控制項。 方法 SyncChanges() 會取得正在編輯之控制項的 WebPart 目前值,讓編輯器控制項可以編輯它們。 使用這兩個重要方法,您可以在自訂 EditorPart 控制項與其正在編輯的 WebPart 控制項之間取得和設定值。
如果您衍生自 EditorPart 類別來建立自訂編輯器控制項,您可以在控制項、使用者控制項或伺服器控制項中 WebPart 實 IWebEditable 作 介面,將自訂控制項新增至 EditorZoneBase 區域。 如需詳細資訊和程式碼範例,請參閱 IWebEditable 類別概觀。 此外,範例一節中的程式碼範例會示範如何在自訂 WebPart 控制項中實 IWebEditable 作。
建構函式
EditorPart() |
初始化這個類別,以供繼承的類別執行個體使用。 此建構函式只能由繼承的類別呼叫。 |
屬性
AccessKey |
取得或設定便捷鍵 (Access Key),可讓您快速巡覽至 Web 伺服器控制項。 (繼承來源 WebControl) |
Adapter |
針對控制項取得瀏覽器的特定配置器。 (繼承來源 Control) |
AppRelativeTemplateSourceDirectory |
取得或設定包含了此控制項之 Page 或 UserControl 物件的相對應用程式虛擬目錄。 (繼承來源 Control) |
Attributes |
取得任意屬性 (Attribute) 的集合 (只供呈現),不與控制項上的屬性 (Property) 對應。 (繼承來源 WebControl) |
BackColor |
取得或設定 Web 伺服器控制項的背景色彩。 (繼承來源 WebControl) |
BackImageUrl |
取得或設定面板控制項背景影像的 URL。 (繼承來源 Panel) |
BindingContainer |
取得包含了此控制項之資料繫結的控制項。 (繼承來源 Control) |
BorderColor |
取得或設定 Web 控制項的框線色彩。 (繼承來源 WebControl) |
BorderStyle |
取得或設定 Web 伺服器控制項的框線樣式。 (繼承來源 WebControl) |
BorderWidth |
取得或設定 Web 伺服器控制項的框線寬度。 (繼承來源 WebControl) |
ChildControlsCreated |
取得值,指出是否已經建立伺服器控制項的子控制項。 (繼承來源 Control) |
ChromeState |
取得或設定組件控制項是否為最小化或一般狀態。 (繼承來源 Part) |
ChromeType |
取得或設定圍繞著 Web 組件控制項的框線類型。 (繼承來源 Part) |
ClientID |
取得 ASP.NET 所產生之 HTML 標記的控制項識別碼。 (繼承來源 Control) |
ClientIDMode |
取得或設定用來產生 ClientID 屬性值的演算法。 (繼承來源 Control) |
ClientIDSeparator |
取得字元值,表示在 ClientID 屬性中所使用的分隔字元。 (繼承來源 Control) |
Context |
取得與目前 Web 要求的伺服器控制項關聯的 HttpContext 物件。 (繼承來源 Control) |
Controls |
取得 ControlCollection 物件,其包含使用者介面階層架構中所指定伺服器控制項的子控制項。 (繼承來源 Part) |
ControlStyle |
取得 Web 伺服器控制項的樣式。 這個屬性主要由控制項開發人員使用。 (繼承來源 WebControl) |
ControlStyleCreated |
取得值,指出 Style 物件是否已經為 ControlStyle 屬性建立。 這個屬性主要由控制項開發人員使用。 (繼承來源 WebControl) |
CssClass |
取得或設定用戶端上 Web 伺服器控制項所呈現的階層式樣式表 (CSS)。 (繼承來源 WebControl) |
DataItemContainer |
如果命名容器實作 IDataItemContainer,則取得命名容器的參考。 (繼承來源 Control) |
DataKeysContainer |
如果命名容器實作 IDataKeysControl,則取得命名容器的參考。 (繼承來源 Control) |
DefaultButton |
取得或設定 Panel 控制項中包含之預設按鈕的識別項。 (繼承來源 Panel) |
Description |
取得或設定摘要說明組件控制項功能的簡短片語,用於組件控制項的工具提示和資料目錄。 (繼承來源 Part) |
DesignMode |
取得值,指出控制項是否正用於設計介面上。 (繼承來源 Control) |
Direction |
取得或設定包含文字之控制項在 Panel 控制項中的顯示方向。 (繼承來源 Panel) |
Display |
取得值,指出當與控制項相關聯的 WebPart 控制項處於編輯模式時,是否應該顯示該控制項。 |
DisplayTitle |
取得字串,該字串含有 EditorPart 控制項標題列中所顯示的標題文字。 |
Enabled |
取得或設定值,指出 Web 伺服器控制項是否啟用。 (繼承來源 WebControl) |
EnableTheming |
取得或設定值,指出佈景主題是否套用至此控制項。 (繼承來源 WebControl) |
EnableViewState |
取得或設定值,該值表示伺服器控制項是否對要求的用戶端而言保持其檢視狀態,以及它包含的任何子控制項狀態。 (繼承來源 Control) |
Events |
取得控制項事件處理常式委派 (Delegate) 的清單。 這個屬性是唯讀的。 (繼承來源 Control) |
Font |
取得與 Web 伺服器控制項關聯的字型屬性。 (繼承來源 WebControl) |
ForeColor |
取得或設定 Web 伺服器控制項的前景色彩 (通常是文字的色彩)。 (繼承來源 WebControl) |
GroupingText |
取得或設定面板控制項中包含之控制項群組的標題。 (繼承來源 Panel) |
HasAttributes |
取得值,指出控制項是否已經設定屬性。 (繼承來源 WebControl) |
HasChildViewState |
取得值,指出目前伺服器控制項的子控制項是否有任何已儲存的檢視狀態設定。 (繼承來源 Control) |
Height |
取得或設定 Web 伺服器控制項的高度。 (繼承來源 WebControl) |
HorizontalAlign |
取得或設定在面板中內容的水平對齊。 (繼承來源 Panel) |
ID |
取得或設定指派給伺服器控制項的程式設計識別項。 (繼承來源 Control) |
IdSeparator |
取得用來分隔控制項識別項的字元。 (繼承來源 Control) |
IsChildControlStateCleared |
取得值,指出這個控制項中所包含的控制項是否有控制項狀態。 (繼承來源 Control) |
IsEnabled |
取得值,指出是否啟用控制項。 (繼承來源 WebControl) |
IsTrackingViewState |
取得值,指出伺服器控制項是否正在儲存檢視狀態的變更。 (繼承來源 Control) |
IsViewStateEnabled |
取得值,指出這個控制項是否已啟用檢視狀態。 (繼承來源 Control) |
LoadViewStateByID |
取得值,指出控制項是否依 ID (而不是索引) 參與載入其檢視狀態。 (繼承來源 Control) |
NamingContainer |
取得伺服器控制項命名容器的參考,其建立唯一命名空間,在具有相同 ID 屬性值的伺服器控制項之間作區別。 (繼承來源 Control) |
Page |
取得含有伺服器控制項的 Page 執行個體的參考。 (繼承來源 Control) |
Parent |
在網頁控制階層架構中取得伺服器控制項之父控制項的參考。 (繼承來源 Control) |
RenderingCompatibility |
取得值,這個值會指定將與呈現 HTML 相容的 ASP.NET 版本。 (繼承來源 Control) |
ScrollBars |
取得或設定在 Panel 控制項中捲軸的可視性和位置。 (繼承來源 Panel) |
Site |
當呈現在設計介面上時,取得裝載目前控制項之容器的資訊。 (繼承來源 Control) |
SkinID |
取得或設定要套用至控制項的面板。 (繼承來源 WebControl) |
Style |
取得文字屬性的集合,將呈現為 Web 伺服器控制項的外部標記上的樣式屬性。 (繼承來源 WebControl) |
SupportsDisabledAttribute |
取得值,這個值表示當控制項的 |
TabIndex |
取得或設定 Web 伺服器控制項的定位索引。 (繼承來源 WebControl) |
TagKey |
取得對應至這個 Web 伺服器控制項的 HtmlTextWriterTag 值。 這個屬性主要由控制項開發人員使用。 (繼承來源 WebControl) |
TagName |
取得控制項標記的名稱。 這個屬性主要由控制項開發人員使用。 (繼承來源 WebControl) |
TemplateControl |
取得或設定包含了此控制項之樣板的參考。 (繼承來源 Control) |
TemplateSourceDirectory |
取得包含目前伺服器控制項的 Page 或 UserControl 的虛擬目錄。 (繼承來源 Control) |
Title |
取得或設定組件控制項標題。 (繼承來源 Part) |
ToolTip |
取得或設定當滑鼠指標停留在 Web 伺服器控制項時顯示的文字。 (繼承來源 WebControl) |
UniqueID |
取得伺服器控制項唯一的、符合階層架構的識別項。 (繼承來源 Control) |
ValidateRequestMode |
取得或設定值,指出控制項是否對來自瀏覽器的用戶端輸入檢查潛在的危險值。 (繼承來源 Control) |
ViewState |
取得狀態資訊的字典,允許您在相同網頁的多個要求之間,儲存和還原伺服器控制項的檢視狀態。 (繼承來源 Control) |
ViewStateIgnoresCase |
取得值,指出 StateBag 物件是否不區分大小寫。 (繼承來源 Control) |
ViewStateMode |
取得或設定這個控制項的檢視狀態模式。 (繼承來源 Control) |
Visible |
取得或設定值,指出伺服器控制項是否會轉譯為頁面上的 UI。 (繼承來源 Control) |
WebPartManager |
取得與目前 Web 網頁相關聯 WebPartManager 之控制項的參考。 |
WebPartToEdit |
取得對目前正在編輯之 WebPart 控制項的參考。 |
Width |
取得或設定 Web 伺服器控制項的寬度。 (繼承來源 WebControl) |
Wrap |
取得或設定值,指示面板中的內容是否換行。 (繼承來源 Panel) |
Zone |
取得包含 EditorZoneBase 控制項之 EditorPart 區域的參考。 |
方法
AddAttributesToRender(HtmlTextWriter) |
將背景影像、對齊方式、換行和方向的相關資訊加入要呈現的屬性清單中。 (繼承來源 Panel) |
AddedControl(Control, Int32) |
在子控制項加入 Control 物件的 Controls 集合後呼叫。 (繼承來源 Control) |
AddParsedSubObject(Object) |
通知伺服器控制項,XML 或 HTML 項目已剖析,並將項目加入伺服器控制項的 ControlCollection 物件中。 (繼承來源 Control) |
ApplyChanges() |
將值從 EditorPart 控制項儲存至相關聯 WebPart 控制項中對應的屬性。 |
ApplyStyle(Style) |
將指定樣式的任何非空白項目加入到 Web 控制項中,覆寫控制項的任何現有的樣式項目。 這個方法主要由控制項開發人員使用。 (繼承來源 WebControl) |
ApplyStyleSheetSkin(Page) |
將頁面樣式表中所定義的樣式屬性套用至控制項。 (繼承來源 Control) |
BeginRenderTracing(TextWriter, Object) |
開始進行轉譯資料的設計階段追蹤。 (繼承來源 Control) |
BuildProfileTree(String, Boolean) |
收集伺服器控制項的相關資訊,並在頁面啟用追蹤時將此資訊傳遞至 Trace 屬性以顯示之。 (繼承來源 Control) |
ClearCachedClientID() |
將快取的 ClientID 值設定為 |
ClearChildControlState() |
刪除伺服器控制項之子控制項的控制項狀態資訊。 (繼承來源 Control) |
ClearChildState() |
刪除所有伺服器控制項之子控制項的檢視狀態和控制項狀態資訊。 (繼承來源 Control) |
ClearChildViewState() |
刪除所有伺服器控制項之子控制項的檢視狀態資訊。 (繼承來源 Control) |
ClearEffectiveClientIDMode() |
將目前的控制項執行個體和任何子控制項的 ClientIDMode 屬性設定為 Inherit。 (繼承來源 Control) |
CopyBaseAttributes(WebControl) |
將不被 Style 物件封裝的屬性從指定的 Web 伺服器控制項複製到呼叫這個方法的 Web 伺服器控制項上。 這個方法主要由控制項開發人員使用。 (繼承來源 WebControl) |
CreateChildControls() |
由 ASP.NET 網頁架構呼叫,通知使用組合實作的伺服器控制項來建立所包含的任何子控制項,以準備回傳或呈現。 (繼承來源 Control) |
CreateControlCollection() |
建立新的 ControlCollection 物件來保存伺服器控制項的子控制項 (常值和伺服器)。 (繼承來源 Control) |
CreateControlStyle() |
建立樣式物件,這個物件是由 Panel 控制項在內部使用,以實作所有的樣式相關屬性。 (繼承來源 Panel) |
DataBind() |
將資料來源繫結至所叫用的伺服器控制項及其所有子控制項。 (繼承來源 Part) |
DataBind(Boolean) |
使用會引發 DataBinding 事件的選項,繫結資料來源至叫用的伺服器控制項及其所有子控制項。 (繼承來源 Control) |
DataBindChildren() |
繫結資料來源至伺服器控制項的子控制項。 (繼承來源 Control) |
Dispose() |
啟用伺服器控制項,在它從記憶體釋放之前執行最後清除。 (繼承來源 Control) |
EndRenderTracing(TextWriter, Object) |
結束轉譯資料的設計階段追蹤。 (繼承來源 Control) |
EnsureChildControls() |
判斷伺服器控制項是否包含子控制項。 如果不包含,則建立子控制項。 (繼承來源 Control) |
EnsureID() |
為尚未指定識別項的控制項,建立識別項。 (繼承來源 Control) |
Equals(Object) |
判斷指定的物件是否等於目前的物件。 (繼承來源 Object) |
FindControl(String) |
在目前命名容器搜尋具有指定 |
FindControl(String, Int32) |
使用指定的 |
Focus() |
設定控制項的輸入焦點。 (繼承來源 Control) |
GetDesignModeState() |
擷取 EditorPart 控制項之父區域的目前狀態。 |
GetHashCode() |
做為預設雜湊函式。 (繼承來源 Object) |
GetRouteUrl(Object) |
取得會對應於一組路由參數的 URL。 (繼承來源 Control) |
GetRouteUrl(RouteValueDictionary) |
取得會對應於一組路由參數的 URL。 (繼承來源 Control) |
GetRouteUrl(String, Object) |
取得 URL,此 URL 對應於一組路由參數及一個路由名稱。 (繼承來源 Control) |
GetRouteUrl(String, RouteValueDictionary) |
取得 URL,此 URL 對應於一組路由參數及一個路由名稱。 (繼承來源 Control) |
GetType() |
取得目前執行個體的 Type。 (繼承來源 Object) |
GetUniqueIDRelativeTo(Control) |
傳回指定之控制項 UniqueID 屬性的前置部分。 (繼承來源 Control) |
HasControls() |
判斷伺服器控制項是否包含任何子控制項。 (繼承來源 Control) |
HasEvents() |
傳回值,指出控制項或任何子控制項的事件是否已註冊。 (繼承來源 Control) |
IsLiteralContent() |
判斷伺服器控制項是否只儲存常值內容。 (繼承來源 Control) |
LoadControlState(Object) |
從 SaveControlState() 方法所儲存的上一頁要求中,還原控制項狀態資訊。 (繼承來源 Control) |
LoadViewState(Object) |
從上一個使用 SaveViewState() 方法儲存的要求中,還原檢視狀態資訊。 (繼承來源 WebControl) |
MapPathSecure(String) |
擷取虛擬絕對路徑或相對路徑所對應至的實體路徑。 (繼承來源 Control) |
MemberwiseClone() |
建立目前 Object 的淺層複製。 (繼承來源 Object) |
MergeStyle(Style) |
將指定樣式的任何非空白項目複製到 Web 控制項,但不覆寫控制項的任何現有樣式項目。 這個方法主要由控制項開發人員使用。 (繼承來源 WebControl) |
OnBubbleEvent(Object, EventArgs) |
決定伺服器控制項的事件是否要在頁面的 UI 伺服器控制項階層架構中向上傳遞。 (繼承來源 Control) |
OnDataBinding(EventArgs) |
引發 DataBinding 事件。 (繼承來源 Control) |
OnInit(EventArgs) |
引發 Init 事件。 (繼承來源 Control) |
OnLoad(EventArgs) |
引發 Load 事件。 (繼承來源 Control) |
OnPreRender(EventArgs) |
引發 PreRender 事件。 |
OnUnload(EventArgs) |
引發 Unload 事件。 (繼承來源 Control) |
OpenFile(String) |
取得用來讀取檔案的 Stream。 (繼承來源 Control) |
RaiseBubbleEvent(Object, EventArgs) |
指派事件的任何來源和它的資訊至控制項的父控制項。 (繼承來源 Control) |
RemovedControl(Control) |
從 Control 物件的 Controls 集合中移除子控制項之後呼叫。 (繼承來源 Control) |
Render(HtmlTextWriter) |
將控制項呈現在指定的 HTML 寫入器中。 (繼承來源 WebControl) |
RenderBeginTag(HtmlTextWriter) |
將 Panel 控制項的 HTML 開頭標記呈現在指定的寫入器中。 (繼承來源 Panel) |
RenderChildren(HtmlTextWriter) |
將伺服器控制項子系的內容輸出至提供的 HtmlTextWriter 物件,再由這個物件在用戶端上寫入要轉譯的內容。 (繼承來源 Control) |
RenderContents(HtmlTextWriter) |
將控制項的內容呈現在指定的寫入器。 這個方法主要由控制項開發人員使用。 (繼承來源 WebControl) |
RenderControl(HtmlTextWriter) |
將伺服器控制項內容輸出至提供的 HtmlTextWriter 物件,並在啟用追蹤時儲存控制項的追蹤資訊。 (繼承來源 Control) |
RenderControl(HtmlTextWriter, ControlAdapter) |
使用提供的 HtmlTextWriter 物件,輸出伺服器控制項內容至提供的 ControlAdapter 物件。 (繼承來源 Control) |
RenderEndTag(HtmlTextWriter) |
將 Panel 控制項的 HTML 結尾標記呈現在指定的寫入器中。 (繼承來源 Panel) |
ResolveAdapter() |
取得負責呈現指定之控制項的控制項配置器。 (繼承來源 Control) |
ResolveClientUrl(String) |
取得瀏覽器可使用的 URL。 (繼承來源 Control) |
ResolveUrl(String) |
將 URL 轉換為要求用戶端可使用的 URL。 (繼承來源 Control) |
SaveControlState() |
儲存頁面回傳至伺服器以來,所發生的任何伺服器控制項狀態變更。 (繼承來源 Control) |
SaveViewState() |
儲存叫用 TrackViewState() 方法後已修改的任何狀態。 (繼承來源 WebControl) |
SetDesignModeState(IDictionary) |
將設計模式狀態的特性套用至目前的 EditorZoneBase 區域,這個區域含有 EditorPart 控制項。 |
SetRenderMethodDelegate(RenderMethod) |
指定事件處理常式委派,以呈現伺服器控制項及其內容至其父控制項。 (繼承來源 Control) |
SetTraceData(Object, Object) |
使用追蹤資料機碼和追蹤資料值,設定設計階段期間追蹤呈現資料的追蹤資料。 (繼承來源 Control) |
SetTraceData(Object, Object, Object) |
使用追蹤的物體、追蹤資料機碼和追蹤資料值,設定設計階段期間追蹤呈現資料的追蹤資料。 (繼承來源 Control) |
SyncChanges() |
從 WebPart 控制項擷取屬性值,以供相關聯的 EditorPart 控制項使用。 |
ToString() |
傳回代表目前物件的字串。 (繼承來源 Object) |
TrackViewState() |
讓控制項追蹤其檢視狀態的變更,以便將這些變更儲存在物件的 ViewState 屬性中。 (繼承來源 WebControl) |
事件
DataBinding |
發生於伺服器控制項繫結至資料來源時。 (繼承來源 Control) |
Disposed |
發生於伺服器控制項從記憶體釋放時,這是在要求 ASP.NET 網頁時,伺服器控制項生命週期的最後階段。 (繼承來源 Control) |
Init |
發生於初始化伺服器控制項時,是其生命週期中的第一個步驟。 (繼承來源 Control) |
Load |
發生於載入伺服器控制項至 Page 物件時。 (繼承來源 Control) |
PreRender |
在 Control 物件載入之後但在呈現之前發生。 (繼承來源 Control) |
Unload |
發生於伺服器控制項從記憶體卸載時。 (繼承來源 Control) |
明確介面實作
擴充方法
FindDataSourceControl(Control) |
傳回與指定之控制項的資料控制項相關聯的資料來源。 |
FindFieldTemplate(Control, String) |
傳回在指定之控制項的命名容器中所指定資料行的欄位樣板。 |
FindMetaTable(Control) |
傳回包含資料控制項的中繼資料表物件。 |
GetDefaultValues(INamingContainer) |
取得所指定資料控制項的預設值集合。 |
GetMetaTable(INamingContainer) |
取得所指定資料控制項中的資料表中繼資料。 |
SetMetaTable(INamingContainer, MetaTable) |
設定所指定資料控制項中的資料表中繼資料。 |
SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) |
設定所指定資料控制項的資料表中繼資料及預設值對應。 |
SetMetaTable(INamingContainer, MetaTable, Object) |
設定所指定資料控制項的資料表中繼資料及預設值對應。 |
TryGetMetaTable(INamingContainer, MetaTable) |
判斷資料表中繼資料是否可供使用。 |
EnableDynamicData(INamingContainer, Type) |
針對指定的資料控制項啟用動態資料行為。 |
EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) |
針對指定的資料控制項啟用動態資料行為。 |
EnableDynamicData(INamingContainer, Type, Object) |
針對指定的資料控制項啟用動態資料行為。 |
適用於
另請參閱
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應