WebControl 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
充当基类，该基类定义 System.Web.UI.WebControls 命名空间中的所有控件常见的方法、属性和事件。
public ref class WebControl : System::Web::UI::Control, System::Web::UI::IAttributeAccessorpublic 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.IAttributeAccessortype WebControl = class
inherit Control
interface IAttributeAccessor[<System.Web.UI.Themeable(true)>]
type WebControl = class
inherit Control
interface IAttributeAccessorPublic 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 属性来启用和禁用控件。 控件在 Tab 键顺序中的位置是通过设置 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(HtmlTextWriterTag) |
使用指定的 HTML 标记初始化 WebControl 类的新实例。 |
| WebControl(String) |
使用指定的 HTML 标记初始化 WebControl 类的新实例。 |
属性
| AccessKey |
获取或设置使您得以快速导航到 Web 服务器控件的访问键。 |
| Adapter |
获取控件的浏览器特定适配器。 (继承自 Control) |
| AppRelativeTemplateSourceDirectory |
获取或设置包含该控件的 Page 或 UserControl 对象的应用程序相对虚拟目录。 (继承自 Control) |
| Attributes |
获取与控件的特性不对应的任意特性（只用于呈现）的集合。 |
| BackColor |
获取或设置 Web 服务器控件的背景色。 |
| BindingContainer |
获取包含该控件的数据绑定的控件。 (继承自 Control) |
| BorderColor |
获取或设置 Web 控件的边框颜色。 |
| BorderStyle |
获取或设置 Web 服务器控件的边框样式。 |
| BorderWidth |
获取或设置 Web 服务器控件的边框宽度。 |
| ChildControlsCreated |
获取一个值，该值指示是否已创建服务器控件的子控件。 (继承自 Control) |
| ClientID |
获取由 ASP.NET 生成的 HTML 标记的控件 ID。 (继承自 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 |
获取控件的事件处理程序委托列表。 此属性为只读。 (继承自 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 |
获取对页 UI 层次结构中服务器控件的父控件的引用。 (继承自 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 服务器控件的宽度。 |
方法
事件
| DataBinding |
当服务器控件绑定到数据源时发生。 (继承自 Control) |
| Disposed |
当从内存释放服务器控件时发生，这是请求 ASP.NET 页时服务器控件生存期的最后阶段。 (继承自 Control) |
| Init |
当服务器控件初始化时发生；初始化是控件生存期的第一步。 (继承自 Control) |
| Load |
当服务器控件加载到 Page 对象中时发生。 (继承自 Control) |
| PreRender |
在加载 Control 对象之后、呈现之前发生。 (继承自 Control) |
| Unload |
当服务器控件从内存中卸载时发生。 (继承自 Control) |
显式接口实现
扩展方法
| FindDataSourceControl(Control) |
返回与指定控件的数据控件关联的数据源。 |
| FindFieldTemplate(Control, String) |
返回指定控件的命名容器中指定列的字段模板。 |
| FindMetaTable(Control) |
返回包含数据控件的元表对象。 |
