WebControl 類別
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
作為基底類別,在 System.Web.UI.WebControls 命名空間中定義對所有控制項通用的方法、屬性和事件。
public ref class WebControl : System::Web::UI::Control, System::Web::UI::IAttributeAccessor
public class WebControl : System.Web.UI.Control, System.Web.UI.IAttributeAccessor
[System.Web.UI.Themeable(true)]
public class WebControl : System.Web.UI.Control, System.Web.UI.IAttributeAccessor
type WebControl = class
inherit Control
interface IAttributeAccessor
[<System.Web.UI.Themeable(true)>]
type WebControl = class
inherit Control
interface IAttributeAccessor
Public Class WebControl
Inherits Control
Implements IAttributeAccessor
- 繼承
- 衍生
- 屬性
- 實作
範例
namespace ControlTest
{
using System;
using System.Web.UI;
using System.Web.UI.WebControls;
// Renders the following HTML:
// <span onclick="alert('Hello');" style="color:Red;">Custom Contents</span>
public class MyWebControl: WebControl {
public MyWebControl() : base(HtmlTextWriterTag.Span)
{ }
[System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")]
protected override void AddAttributesToRender(HtmlTextWriter writer)
{
writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');");
writer.AddStyleAttribute(HtmlTextWriterStyle.Color, "Red");
base.AddAttributesToRender(writer);
}
[System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")]
protected override void RenderContents(HtmlTextWriter writer)
{
writer.Write("Custom Contents");
base.RenderContents(writer);
}
}
}
Imports System.Web.UI
Imports System.Web.UI.WebControls
Namespace ControlTest
' Renders the following HTML:
' <span onclick="alert('Hello');" style="color:Red;">Custom Contents</span>
Public Class MyWebControl
Inherits WebControl
Public Sub New()
MyBase.New(HtmlTextWriterTag.Span)
End Sub
<System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
Protected Overrides Sub AddAttributesToRender(writer As HtmlTextWriter)
writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');")
writer.AddStyleAttribute(HtmlTextWriterStyle.Color, "Red")
MyBase.AddAttributesToRender(writer)
End Sub
<System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
Protected Overrides Sub RenderContents(writer As HtmlTextWriter)
writer.Write("Custom Contents")
MyBase.RenderContents(writer)
End Sub
End Class
End Namespace 'ControlTest
備註
類別 WebControl 提供所有 Web 伺服器控制項通用的屬性、方法和事件。 您可以藉由設定此類別中定義的屬性,來控制 Web 伺服器控制元件的外觀和行為。 例如,控件的背景色彩和字型色彩分別使用 BackColor 和 ForeColor 屬性來控制。 在可顯示框線的控制元件上,您可以藉由設定 BorderWidth、 BorderStyle和 BorderColor 屬性來控制框線寬度、框線樣式和框線色彩。 您可以使用和 Width 屬性來指定 Height Web 伺服器控制元件的大小。
您可以藉由設定特定屬性來指定控制件的行為。 您可以藉由設定 Enabled 屬性來啟用和停用控制項。 控件在定位順序中的位置是藉由設定 TabIndex 屬性來控制。 您可以藉由設定 ToolTip 屬性來指定控制項的工具提示。
注意
並非所有控制件都支援這個類別中定義的每個屬性。 如需是否支援屬性的特定資訊,請參閱特定控件的檔。
注意
根據瀏覽器,此類別中的某些屬性會以不同的方式呈現。 有些屬性完全不會轉譯,而其他屬性則呈現,但沒有任何作用。 對象的 TagWriter 屬性 HttpBrowserCapabilities 會決定 Web 伺服器控制件呈現的方式。 對於支援 HTML 4.0 的瀏覽器,屬性 TagWriter 將包含一般 HttpBrowserCapabilities 物件,而且大部分的屬性都會使用 HTML 4.0 樣式屬性來轉譯。 不知道支援 HTML 4.0 的瀏覽器會使用 Html32TextWriter 物件。 這會自動將樣式屬性對應至任何相關的 HTML 3.2 標記屬性。 在某些情況下,例如 使用 ForeColor 屬性,樣式屬性會轉換成其他標籤,例如 <font>
標記。 在某些情況下,不會執行任何對應。 如需如何在不同瀏覽器中呈現屬性的特定資訊,請參閱特定屬性的檔。
如需 實例 WebControl的初始屬性值清單,請參閱 建 WebControl 構函式。
建構函式
WebControl() |
初始化 WebControl 類別的新執行個體,這個執行個體表示 |
WebControl(HtmlTextWriterTag) |
使用指定的 HTML 標記,初始化 WebControl 類別的新執行個體。 |
WebControl(String) |
使用指定的 HTML 標記,初始化 WebControl 類別的新執行個體。 |
屬性
AccessKey |
取得或設定便捷鍵 (Access Key),可讓您快速巡覽至 Web 伺服器控制項。 |
Adapter |
針對控制項取得瀏覽器的特定配置器。 (繼承來源 Control) |
AppRelativeTemplateSourceDirectory |
取得或設定包含了此控制項之 Page 或 UserControl 物件的相對應用程式虛擬目錄。 (繼承來源 Control) |
Attributes |
取得任意屬性 (Attribute) 的集合 (只供呈現),不與控制項上的屬性 (Property) 對應。 |
BackColor |
取得或設定 Web 伺服器控制項的背景色彩。 |
BindingContainer |
取得包含了此控制項之資料繫結的控制項。 (繼承來源 Control) |
BorderColor |
取得或設定 Web 控制項的框線色彩。 |
BorderStyle |
取得或設定 Web 伺服器控制項的框線樣式。 |
BorderWidth |
取得或設定 Web 伺服器控制項的框線寬度。 |
ChildControlsCreated |
取得值,指出是否已經建立伺服器控制項的子控制項。 (繼承來源 Control) |
ClientID |
取得 ASP.NET 所產生之 HTML 標記的控制項識別碼。 (繼承來源 Control) |
ClientIDMode |
取得或設定用來產生 ClientID 屬性值的演算法。 (繼承來源 Control) |
ClientIDSeparator |
取得字元值,表示在 ClientID 屬性中所使用的分隔字元。 (繼承來源 Control) |
Context |
取得與目前 Web 要求的伺服器控制項關聯的 HttpContext 物件。 (繼承來源 Control) |
Controls |
取得 ControlCollection 物件,表示 UI 階層架構中指定之伺服器控制項的子控制項。 (繼承來源 Control) |
ControlStyle |
取得 Web 伺服器控制項的樣式。 這個屬性主要由控制項開發人員使用。 |
ControlStyleCreated |
取得值,指出 Style 物件是否已經為 ControlStyle 屬性建立。 這個屬性主要由控制項開發人員使用。 |
CssClass |
取得或設定用戶端上 Web 伺服器控制項所呈現的階層式樣式表 (CSS)。 |
DataItemContainer |
如果命名容器實作 IDataItemContainer,則取得命名容器的參考。 (繼承來源 Control) |
DataKeysContainer |
如果命名容器實作 IDataKeysControl,則取得命名容器的參考。 (繼承來源 Control) |
DesignMode |
取得值,指出控制項是否正用於設計介面上。 (繼承來源 Control) |
DisabledCssClass |
取得或設定當控制項停用時,要套用至所轉譯 HTML 項目的 CSS 類別。 |
Enabled |
取得或設定值,指出 Web 伺服器控制項是否啟用。 |
EnableTheming |
取得或設定值,指出佈景主題是否套用至此控制項。 |
EnableTheming |
取得或設定值,指出佈景主題是否套用至此控制項。 (繼承來源 Control) |
EnableViewState |
取得或設定值,該值表示伺服器控制項是否對要求的用戶端而言保持其檢視狀態,以及它包含的任何子控制項狀態。 (繼承來源 Control) |
Events |
取得控制項事件處理常式委派 (Delegate) 的清單。 這個屬性是唯讀的。 (繼承來源 Control) |
Font |
取得與 Web 伺服器控制項關聯的字型屬性。 |
ForeColor |
取得或設定 Web 伺服器控制項的前景色彩 (通常是文字的色彩)。 |
HasAttributes |
取得值,指出控制項是否已經設定屬性。 |
HasChildViewState |
取得值,指出目前伺服器控制項的子控制項是否有任何已儲存的檢視狀態設定。 (繼承來源 Control) |
Height |
取得或設定 Web 伺服器控制項的高度。 |
ID |
取得或設定指派給伺服器控制項的程式設計識別項。 (繼承來源 Control) |
IdSeparator |
取得用來分隔控制項識別項的字元。 (繼承來源 Control) |
IsChildControlStateCleared |
取得值,指出這個控制項中所包含的控制項是否有控制項狀態。 (繼承來源 Control) |
IsEnabled |
取得值,指出是否啟用控制項。 |
IsTrackingViewState |
取得值,指出伺服器控制項是否正在儲存檢視狀態的變更。 (繼承來源 Control) |
IsViewStateEnabled |
取得值,指出這個控制項是否已啟用檢視狀態。 (繼承來源 Control) |
LoadViewStateByID |
取得值,指出控制項是否依 ID (而不是索引) 參與載入其檢視狀態。 (繼承來源 Control) |
NamingContainer |
取得伺服器控制項命名容器的參考,其建立唯一命名空間,在具有相同 ID 屬性值的伺服器控制項之間作區別。 (繼承來源 Control) |
Page |
取得含有伺服器控制項的 Page 執行個體的參考。 (繼承來源 Control) |
Parent |
在網頁控制階層架構中取得伺服器控制項之父控制項的參考。 (繼承來源 Control) |
RenderingCompatibility |
取得值,這個值會指定將與呈現 HTML 相容的 ASP.NET 版本。 (繼承來源 Control) |
Site |
當呈現在設計介面上時,取得裝載目前控制項之容器的資訊。 (繼承來源 Control) |
SkinID |
取得或設定要套用至控制項的面板。 |
SkinID |
取得或設定要套用至控制項的面板。 (繼承來源 Control) |
Style |
取得文字屬性的集合,將呈現為 Web 伺服器控制項的外部標記上的樣式屬性。 |
SupportsDisabledAttribute |
取得值,這個值表示當控制項的 |
TabIndex |
取得或設定 Web 伺服器控制項的定位索引。 |
TagKey |
取得對應至這個 Web 伺服器控制項的 HtmlTextWriterTag 值。 這個屬性主要由控制項開發人員使用。 |
TagName |
取得控制項標記的名稱。 這個屬性主要由控制項開發人員使用。 |
TemplateControl |
取得或設定包含了此控制項之樣板的參考。 (繼承來源 Control) |
TemplateSourceDirectory |
取得包含目前伺服器控制項的 Page 或 UserControl 的虛擬目錄。 (繼承來源 Control) |
ToolTip |
取得或設定當滑鼠指標停留在 Web 伺服器控制項時顯示的文字。 |
UniqueID |
取得伺服器控制項唯一的、符合階層架構的識別項。 (繼承來源 Control) |
ValidateRequestMode |
取得或設定值,指出控制項是否對來自瀏覽器的用戶端輸入檢查潛在的危險值。 (繼承來源 Control) |
ViewState |
取得狀態資訊的字典,允許您在相同網頁的多個要求之間,儲存和還原伺服器控制項的檢視狀態。 (繼承來源 Control) |
ViewStateIgnoresCase |
取得值,指出 StateBag 物件是否不區分大小寫。 (繼承來源 Control) |
ViewStateMode |
取得或設定這個控制項的檢視狀態模式。 (繼承來源 Control) |
Visible |
取得或設定值,指出伺服器控制項是否會轉譯為頁面上的 UI。 (繼承來源 Control) |
Width |
取得或設定 Web 伺服器控制項的寬度。 |
方法
AddAttributesToRender(HtmlTextWriter) |
將需要呈現的 HTML 屬性和樣式加入至指定的 HtmlTextWriterTag 中。 這個方法主要由控制項開發人員使用。 |
AddedControl(Control, Int32) |
在子控制項加入 Control 物件的 Controls 集合後呼叫。 (繼承來源 Control) |
AddParsedSubObject(Object) |
通知伺服器控制項,XML 或 HTML 項目已剖析,並將項目加入伺服器控制項的 ControlCollection 物件中。 (繼承來源 Control) |
ApplyStyle(Style) |
將指定樣式的任何非空白項目加入到 Web 控制項中,覆寫控制項的任何現有的樣式項目。 這個方法主要由控制項開發人員使用。 |
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 伺服器控制項上。 這個方法主要由控制項開發人員使用。 |
CreateChildControls() |
由 ASP.NET 網頁架構呼叫,通知使用組合實作的伺服器控制項來建立所包含的任何子控制項,以準備回傳或呈現。 (繼承來源 Control) |
CreateControlCollection() |
建立新的 ControlCollection 物件來保存伺服器控制項的子控制項 (常值和伺服器)。 (繼承來源 Control) |
CreateControlStyle() |
建立樣式物件,這個物件被 WebControl 類別內部使用,以實作所有的樣式相關屬性。 這個方法主要由控制項開發人員使用。 |
DataBind() |
將資料來源繫結至所叫用的伺服器控制項及其所有子控制項。 (繼承來源 Control) |
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() |
取得控制項的設計階段資料。 (繼承來源 Control) |
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() 方法儲存的要求中,還原檢視狀態資訊。 |
MapPathSecure(String) |
擷取虛擬絕對路徑或相對路徑所對應至的實體路徑。 (繼承來源 Control) |
MemberwiseClone() |
建立目前 Object 的淺層複製。 (繼承來源 Object) |
MergeStyle(Style) |
將指定樣式的任何非空白項目複製到 Web 控制項,但不覆寫控制項的任何現有樣式項目。 這個方法主要由控制項開發人員使用。 |
OnBubbleEvent(Object, EventArgs) |
決定伺服器控制項的事件是否要在頁面的 UI 伺服器控制項階層架構中向上傳遞。 (繼承來源 Control) |
OnDataBinding(EventArgs) |
引發 DataBinding 事件。 (繼承來源 Control) |
OnInit(EventArgs) |
引發 Init 事件。 (繼承來源 Control) |
OnLoad(EventArgs) |
引發 Load 事件。 (繼承來源 Control) |
OnPreRender(EventArgs) |
引發 PreRender 事件。 (繼承來源 Control) |
OnUnload(EventArgs) |
引發 Unload 事件。 (繼承來源 Control) |
OpenFile(String) |
取得用來讀取檔案的 Stream。 (繼承來源 Control) |
RaiseBubbleEvent(Object, EventArgs) |
指派事件的任何來源和它的資訊至控制項的父控制項。 (繼承來源 Control) |
RemovedControl(Control) |
從 Control 物件的 Controls 集合中移除子控制項之後呼叫。 (繼承來源 Control) |
Render(HtmlTextWriter) |
將控制項呈現在指定的 HTML 寫入器中。 |
RenderBeginTag(HtmlTextWriter) |
將控制項的 HTML 開頭標記呈現在指定的寫入器中。 這個方法主要由控制項開發人員使用。 |
RenderChildren(HtmlTextWriter) |
將伺服器控制項子系的內容輸出至提供的 HtmlTextWriter 物件,再由這個物件在用戶端上寫入要轉譯的內容。 (繼承來源 Control) |
RenderContents(HtmlTextWriter) |
將控制項的內容呈現在指定的寫入器。 這個方法主要由控制項開發人員使用。 |
RenderControl(HtmlTextWriter) |
將伺服器控制項內容輸出至提供的 HtmlTextWriter 物件,並在啟用追蹤時儲存控制項的追蹤資訊。 (繼承來源 Control) |
RenderControl(HtmlTextWriter, ControlAdapter) |
使用提供的 HtmlTextWriter 物件,輸出伺服器控制項內容至提供的 ControlAdapter 物件。 (繼承來源 Control) |
RenderEndTag(HtmlTextWriter) |
將控制項的 HTML 結尾標記呈現至指定的寫入器。 這個方法主要由控制項開發人員使用。 |
ResolveAdapter() |
取得負責呈現指定之控制項的控制項配置器。 (繼承來源 Control) |
ResolveClientUrl(String) |
取得瀏覽器可使用的 URL。 (繼承來源 Control) |
ResolveUrl(String) |
將 URL 轉換為要求用戶端可使用的 URL。 (繼承來源 Control) |
SaveControlState() |
儲存頁面回傳至伺服器以來,所發生的任何伺服器控制項狀態變更。 (繼承來源 Control) |
SaveViewState() |
儲存叫用 TrackViewState() 方法後已修改的任何狀態。 |
SetDesignModeState(IDictionary) |
設定控制項的設計階段資料。 (繼承來源 Control) |
SetRenderMethodDelegate(RenderMethod) |
指定事件處理常式委派,以呈現伺服器控制項及其內容至其父控制項。 (繼承來源 Control) |
SetTraceData(Object, Object) |
使用追蹤資料機碼和追蹤資料值,設定設計階段期間追蹤呈現資料的追蹤資料。 (繼承來源 Control) |
SetTraceData(Object, Object, Object) |
使用追蹤的物體、追蹤資料機碼和追蹤資料值,設定設計階段期間追蹤呈現資料的追蹤資料。 (繼承來源 Control) |
ToString() |
傳回代表目前物件的字串。 (繼承來源 Object) |
TrackViewState() |
讓控制項追蹤其檢視狀態的變更,以便將這些變更儲存在物件的 ViewState 屬性中。 |
事件
DataBinding |
發生於伺服器控制項繫結至資料來源時。 (繼承來源 Control) |
Disposed |
發生於伺服器控制項從記憶體釋放時,這是在要求 ASP.NET 網頁時,伺服器控制項生命週期的最後階段。 (繼承來源 Control) |
Init |
發生於初始化伺服器控制項時,是其生命週期中的第一個步驟。 (繼承來源 Control) |
Load |
發生於載入伺服器控制項至 Page 物件時。 (繼承來源 Control) |
PreRender |
在 Control 物件載入之後但在呈現之前發生。 (繼承來源 Control) |
Unload |
發生於伺服器控制項從記憶體卸載時。 (繼承來源 Control) |
明確介面實作
擴充方法
FindDataSourceControl(Control) |
傳回與指定之控制項的資料控制項相關聯的資料來源。 |
FindFieldTemplate(Control, String) |
傳回在指定之控制項的命名容器中所指定資料行的欄位樣板。 |
FindMetaTable(Control) |
傳回包含資料控制項的中繼資料表物件。 |