TemplateControl 类

定义

命名空间:

System.Web.UI

程序集:

System.Web.dll

为 Page 类和 UserControl 类提供了一组基本功能。

public ref class TemplateControl abstract : System::Web::UI::Control, System::Web::UI::IFilterResolutionService, System::Web::UI::INamingContainer

public abstract class TemplateControl : System.Web.UI.Control, System.Web.UI.IFilterResolutionService, System.Web.UI.INamingContainer

type TemplateControl = class
    inherit Control
    interface INamingContainer
    interface IFilterResolutionService

Public MustInherit Class TemplateControl
Inherits Control
Implements IFilterResolutionService, INamingContainer

继承

Object

Control

TemplateControl

派生

System.Web.UI.Page

System.Web.UI.UserControl

实现

INamingContainer IFilterResolutionService

示例

下面的代码示例演示如何从 TemplateControl 类派生名为 的MyControl控件并重写 Construct 方法。 初始化 时 MyControl ，将调用重写 Construct 的方法。

using System;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Security.Permissions;

// The custom user control class.
[AspNetHostingPermission(SecurityAction.Demand,
   Level = AspNetHostingPermissionLevel.Minimal)]
public class MyControl : UserControl
{
    // Create a Message property and accessors.
    private string _message = "No message";

    public string Message
    {
        get { return _message; }
        set { _message = value; }
    }

    // Create an event for this user control
    public event System.EventHandler myControl;

    // Override the default constructor.
    protected override void Construct()
    {
        // Specify the handler for the OnInit method.
        this.myControl += new EventHandler(MyInit);
    }

    protected override void OnInit(EventArgs e)
    {
        myControl(this, e);
        Response.Write("The OnInit() method is used to raise the Init event.");
    }

    // Use the MyInit handler to set the Message property
    void MyInit(object sender, System.EventArgs e)
    {
        Message = "Hello World!";
    }

    // Render the value of the Message property
    protected override void Render(HtmlTextWriter writer)
    {
        writer.Write("<br>Message :" + Message);
    }
}

Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Security.Permissions

' The custom user control class.
<AspNetHostingPermission(SecurityAction.Demand, _
   Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class MyControl
   Inherits UserControl
   ' Create a Message property and accessors.
   Private _message As String = Nothing
   
   Public Property Message() As String
      Get
         Return _message
      End Get
      Set
         _message = value
      End Set
   End Property
   
    ' Create an event for this user control
    Public Event myControl As System.EventHandler

    ' Override the default constructor.
    Protected Overrides Sub Construct()
        ' Specify the handler for the OnInit method.
        AddHandler Me.myControl, AddressOf MyInit
    End Sub

    Protected Overrides Sub OnInit(ByVal e As EventArgs)
        RaiseEvent myControl(Me, e)
        Response.Write("The OnInit() method is used to raise the Init event.")
    End Sub
   
   
    ' Use the MyInit handler to set the Message property
    Sub MyInit(ByVal sender As Object, ByVal e As System.EventArgs)
        Message = "Hello World!"
    End Sub
   
    ' Render the value of the Message property
    Protected Overrides Sub Render(ByVal writer As HtmlTextWriter)
        writer.Write(("<br>Message :" & Message))
    End Sub
End Class

注解

类 TemplateControl 是一个抽象类，它为 Page 类和 类提供通用属性和 UserControl 方法。 不会直接创建 的新 TemplateControl 实例。

类 TemplateControl 定义支持声明性数据绑定表达式的方法：

• Eval对涉及数据源的数据绑定表达式（如简单属性或表达式）使用 方法。

• XPath使用 方法分析和计算 XPath 数据绑定表达式。

• XPathSelect对包含 XPath select 语句的表达式使用 方法进行数据绑定。 结果是实现 接口的 IEnumerable 节点集合。

有关数据绑定表达式的详细信息，请参阅 数据绑定表达式语法 和 绑定到数据库。

构造函数

TemplateControl()

初始化 TemplateControl 类的新实例。

属性

Adapter	获取控件的浏览器特定适配器。 (继承自 Control)
AppRelativeTemplateSourceDirectory	获取或设置包含该控件的 Page 或 UserControl 对象的应用程序相对虚拟目录。 (继承自 Control)
AppRelativeVirtualPath	获取或设置从中解析和编译控件的文件的相对于应用程序的虚拟目录路径。
AutoHandlers	已过时. ASP.NET 2.0 中已弃用 AutoHandlers 属性。 它是由生成的类使用的，不应在代码中使用。
BindingContainer	获取包含该控件的数据绑定的控件。 (继承自 Control)
ChildControlsCreated	获取一个值，该值指示是否已创建服务器控件的子控件。 (继承自 Control)
ClientID	获取由 ASP.NET 生成的 HTML 标记的控件 ID。 (继承自 Control)
ClientIDMode	获取或设置用于生成 ClientID 属性值的算法。 (继承自 Control)
ClientIDSeparator	获取一个字符值，该值表示 ClientID 属性中使用的分隔符字符。 (继承自 Control)
Context	为当前 Web 请求获取与服务器控件关联的 HttpContext 对象。 (继承自 Control)
Controls	获取 ControlCollection 对象，该对象表示 UI 层次结构中的指定服务器控件的子控件。 (继承自 Control)
DataItemContainer	如果命名容器实现 IDataItemContainer，则获取对命名容器的引用。 (继承自 Control)
DataKeysContainer	如果命名容器实现 IDataKeysControl，则获取对命名容器的引用。 (继承自 Control)
DesignMode	获取一个值，该值指示是否正在使用设计图面上的一个控件。 (继承自 Control)
EnableTheming	获取或设置一个布尔值，该值指示主题是否应用于派生自 TemplateControl 类的控件。
EnableViewState	获取或设置一个值，该值指示服务器控件是否向发出请求的客户端保持自己的视图状态以及它所包含的任何子控件的视图状态。 (继承自 Control)
Events	获取控件的事件处理程序委托列表。 此属性为只读。 (继承自 Control)
HasChildViewState	获取一个值，该值指示当前服务器控件的子控件是否具有任何已保存的视图状态设置。 (继承自 Control)
ID	获取或设置分配给服务器控件的编程标识符。 (继承自 Control)
IdSeparator	获取用于分隔控件标识符的字符。 (继承自 Control)
IsChildControlStateCleared	获取一个值，该值指示该控件中包含的控件是否具有控件状态。 (继承自 Control)
IsTrackingViewState	获取一个值，用于指示服务器控件是否会将更改保存到其视图状态中。 (继承自 Control)
IsViewStateEnabled	获取一个值，该值指示是否为该控件启用了视图状态。 (继承自 Control)
LoadViewStateByID	获取一个值，该值指示控件是否通过 ID 而不是索引参与加载其视图状态。 (继承自 Control)
NamingContainer	获取对服务器控件的命名容器的引用，此引用创建唯一的命名空间，以区分具有相同 ID 属性值的服务器控件。 (继承自 Control)
Page	获取对包含服务器控件的 Page 实例的引用。 (继承自 Control)
Parent	获取对页 UI 层次结构中服务器控件的父控件的引用。 (继承自 Control)
RenderingCompatibility	获取一个值，该值指定呈现的 HTML 将与之兼容的 ASP.NET 版本。 (继承自 Control)
Site	获取容器信息，该容器在呈现于设计图面上时承载当前控件。 (继承自 Control)
SkinID	获取或设置要应用于控件的外观。 (继承自 Control)
SupportAutoEvents	获取一个值，该值指示 TemplateControl 控件是否支持自动事件。
TemplateControl	获取或设置对包含该控件的模板的引用。 (继承自 Control)
TemplateSourceDirectory	获取包含当前服务器控件的 Page 或 UserControl 的虚拟目录。 (继承自 Control)
UniqueID	获取服务器控件的唯一的、以分层形式限定的标识符。 (继承自 Control)
ValidateRequestMode	获取或设置指示控件是否检查来自浏览器的客户端输入是否具有潜在危险值的值。 (继承自 Control)
ViewState	获取状态信息的字典，这些信息使您可以在同一页的多个请求间保存和还原服务器控件的视图状态。 (继承自 Control)
ViewStateIgnoresCase	获取一个值，该值指示 StateBag 对象是否不区分大小写。 (继承自 Control)
ViewStateMode	获取或设置此控件的视图状态模式。 (继承自 Control)
Visible	获取或设置一个值，该值指示服务器控件是否作为 UI 呈现在页上。 (继承自 Control)

方法

AddedControl(Control, Int32)	在子控件添加到 Control 对象的 Controls 集合后调用。 (继承自 Control)
AddParsedSubObject(Object)	通知服务器控件，分析了一个元素（XML 或 HTML），并将该元素添加到服务器控件的 ControlCollection 对象中。 (继承自 Control)
ApplyStyleSheetSkin(Page)	将页样式表中定义的样式属性应用到控件。 (继承自 Control)
BeginRenderTracing(TextWriter, Object)	开始输出数据的设计时追踪。 (继承自 Control)
BuildProfileTree(String, Boolean)	收集有关服务器控件的信息并将该信息发送到 Trace 属性，在启用页的跟踪功能时将显示该属性。 (继承自 Control)
ClearCachedClientID()	将缓存的 ClientID 值设置为 null。 (继承自 Control)
ClearChildControlState()	删除服务器控件的子控件的控件状态信息。 (继承自 Control)
ClearChildState()	删除服务器控件的所有子控件的视图状态和控件状态信息。 (继承自 Control)
ClearChildViewState()	删除服务器控件的所有子控件的视图状态信息。 (继承自 Control)
ClearEffectiveClientIDMode()	将当前控件实例和任何子控件的 ClientIDMode 属性设置为 Inherit。 (继承自 Control)
Construct()	执行设计时逻辑。
CreateChildControls()	由 ASP.NET 页框架调用，以通知服务器控件在准备回发或呈现时使用基于撰写的实现来创建其所包含任何子控件。 (继承自 Control)
CreateControlCollection()	创建一个新 ControlCollection 对象来保存服务器控件的子控件（包括文本控件和服务器控件）。 (继承自 Control)
CreateResourceBasedLiteralControl(Int32, Int32, Boolean)	访问存储在资源中的字符串。 CreateResourceBasedLiteralControl(Int32, Int32, Boolean) 方法并不应从代码中使用。
DataBind()	将数据源绑定到调用的服务器控件及其所有子控件。 (继承自 Control)
DataBind(Boolean)	将数据源绑定到调用的服务器控件及其所有子控件，同时可以选择引发 DataBinding 事件。 (继承自 Control)
DataBindChildren()	将数据源绑定到服务器控件的子控件。 (继承自 Control)
Dispose()	使服务器控件得以在从内存中释放之前执行最后的清理操作。 (继承自 Control)
EndRenderTracing(TextWriter, Object)	结束输出数据的设计时追踪。 (继承自 Control)
EnsureChildControls()	确定服务器控件是否包含子控件。 如果不包含，则创建子控件。 (继承自 Control)
EnsureID()	为尚未分配标识符的控件创建标识符。 (继承自 Control)
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
Eval(String)	计算数据绑定表达式。
Eval(String, String)	使用用于显示结果的指定格式字符串计算数据绑定表达式。
FindControl(String)	在当前的命名容器中搜索带指定 id 参数的服务器控件。 (继承自 Control)
FindControl(String, Int32)	使用指定的 id 和 pathOffset 参数（该参数有助于搜索）中指定的整数在当前命名容器中搜索服务器控件。 不应重写此版本的 FindControl 方法。 (继承自 Control)
Focus()	为控件设置输入焦点。 (继承自 Control)
FrameworkInitialize()	初始化派生自 TemplateControl 类的控件。
GetDesignModeState()	获取控件的设计时数据。 (继承自 Control)
GetGlobalResourceObject(String, String)	根据指定的 ClassKey 和 ResourceKey 属性，获取应用程序级别资源对象。
GetGlobalResourceObject(String, String, Type, String)	根据资源的指定 ClassKey 和 ResourceKey 属性、对象类型和属性名称获取应用程序级别的资源对象。
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetLocalResourceObject(String)	根据指定的 ResourceKey 属性获取页级别的资源对象。
GetLocalResourceObject(String, Type, String)	根据指定的 ResourceKey 属性、对象类型和属性名称获取页级别的资源对象。
GetRouteUrl(Object)	获取与一组路由参数对应的 URL。 (继承自 Control)
GetRouteUrl(RouteValueDictionary)	获取与一组路由参数对应的 URL。 (继承自 Control)
GetRouteUrl(String, Object)	获取与一组路由参数以及某个路由名称对应的 URL。 (继承自 Control)
GetRouteUrl(String, RouteValueDictionary)	获取与一组路由参数以及某个路由名称对应的 URL。 (继承自 Control)
GetType()	获取当前实例的 Type。 (继承自 Object)
GetUniqueIDRelativeTo(Control)	返回指定控件的 UniqueID 属性的前缀部分。 (继承自 Control)
HasControls()	确定服务器控件是否包含任何子控件。 (继承自 Control)
HasEvents()	返回一个值，该值指示是否为控件或任何子控件注册事件。 (继承自 Control)
IsLiteralContent()	确定服务器控件是否只包含文字内容。 (继承自 Control)
LoadControl(String)	根据指定的虚拟路径从文件加载 Control 对象。
LoadControl(Type, Object[])	根据指定类型和构造函数参数加载 Control 对象。
LoadControlState(Object)	从 SaveControlState() 方法保存的上一个页请求还原控件状态信息。 (继承自 Control)
LoadTemplate(String)	从外部文件获取 ITemplate 接口的实例。
LoadViewState(Object)	从用 SaveViewState() 方法保存的上一个页面请求还原视图状态信息。 (继承自 Control)
MapPathSecure(String)	检索虚拟路径（绝对的或相对的）映射到的物理路径。 (继承自 Control)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
OnAbortTransaction(EventArgs)	引发 AbortTransaction 事件。
OnBubbleEvent(Object, EventArgs)	确定服务器控件的事件是否沿页的 UI 服务器控件层次结构向上传递。 (继承自 Control)
OnCommitTransaction(EventArgs)	引发 CommitTransaction 事件。
OnDataBinding(EventArgs)	引发 DataBinding 事件。 (继承自 Control)
OnError(EventArgs)	引发 Error 事件。
OnInit(EventArgs)	引发 Init 事件。 (继承自 Control)
OnLoad(EventArgs)	引发 Load 事件。 (继承自 Control)
OnPreRender(EventArgs)	引发 PreRender 事件。 (继承自 Control)
OnUnload(EventArgs)	引发 Unload 事件。 (继承自 Control)
OpenFile(String)	获取用于读取文件的 Stream。 (继承自 Control)
ParseControl(String)	将输入字符串分析为 Web 窗体页或用户控件上的 Control 对象。
ParseControl(String, Boolean)	将输入字符串分析为 ASP.NET 网页或用户控件上的 Control 对象。
RaiseBubbleEvent(Object, EventArgs)	将所有事件源及其信息分配给控件的父级。 (继承自 Control)
ReadStringResource()	读取字符串资源。 ReadStringResource() 方法并不应从代码中使用。
ReadStringResource(Type)	读取字符串资源。 ReadStringResource(Type) 方法并不应从代码中使用。
RemovedControl(Control)	从 Control 对象的 Controls 集合移除子控件后调用。 (继承自 Control)
Render(HtmlTextWriter)	将服务器控件内容发送到给定的 HtmlTextWriter 对象，该对象可编写将在客户端呈现的内容。 (继承自 Control)
RenderChildren(HtmlTextWriter)	将服务器控件子级的内容输出到提供的 HtmlTextWriter 对象，该对象可写入要在客户端上呈现的内容。 (继承自 Control)
RenderControl(HtmlTextWriter)	将服务器控件内容输出到所提供的 HtmlTextWriter 对象，如果启用了跟踪，则还将存储有关该控件的跟踪信息。 (继承自 Control)
RenderControl(HtmlTextWriter, ControlAdapter)	使用提供的 HtmlTextWriter 对象将服务器控件内容输出到提供的 ControlAdapter 对象。 (继承自 Control)
ResolveAdapter()	获取负责呈现指定控件的控件适配器。 (继承自 Control)
ResolveClientUrl(String)	获取浏览器可以使用的 URL。 (继承自 Control)
ResolveUrl(String)	将 URL 转换为在请求客户端可用的 URL。 (继承自 Control)
SaveControlState()	保存将页面回发到服务器之后发生的所有服务器控件状态更改。 (继承自 Control)
SaveViewState()	保存将页面回发到服务器之后发生的所有服务器控件视图状态更改。 (继承自 Control)
SetDesignModeState(IDictionary)	为控件设置设计时数据。 (继承自 Control)
SetRenderMethodDelegate(RenderMethod)	分配事件处理程序委托，以将服务器控件及其内容呈现到父控件中。 (继承自 Control)
SetStringResourcePointer(Object, Int32)	设置指向字符串资源的指针。 SetStringResourcePointer(Object, Int32) 方法是由生成的类使用的，并且不应从代码中使用。
SetTraceData(Object, Object)	使用跟踪数据键和跟踪数据值，为呈现数据的设计时追踪设置跟踪数据。 (继承自 Control)
SetTraceData(Object, Object, Object)	使用跟踪对象、跟踪数据键和跟踪数据值，为呈现数据的设计时追踪设置跟踪数据。 (继承自 Control)
TestDeviceFilter(String)	返回一个布尔值，该值指示是否对该 HTTP 请求应用设备筛选器。
ToString()	返回表示当前对象的字符串。 (继承自 Object)
TrackViewState()	导致跟踪服务器控件的视图状态的更改，以便这些更改可以存储到服务器控件的 StateBag 对象中。 通过 ViewState 属性可访问此对象。 (继承自 Control)
WriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean)	向 HtmlTextWriter 控件写入资源字符串。 WriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean) 方法是由生成的类使用的，并且不应从代码中使用。
XPath(String)	计算 XPath 数据绑定表达式。
XPath(String, IXmlNamespaceResolver)	使用指定的前缀和命名空间映射来计算 XPath 数据绑定表达式，以进行命名空间解析。
XPath(String, String)	计算 XPath 数据绑定表达式，使用指定的格式字符串来显示结果。
XPath(String, String, IXmlNamespaceResolver)	使用用于命名空间解析的指定前缀和命名空间映射以及用于显示结果的指定格式字符串来计算 XPath 数据绑定表达式。
XPathSelect(String)	计算 XPath 数据绑定表达式，并返回实现 IEnumerable 接口的节点集合。
XPathSelect(String, IXmlNamespaceResolver)	使用用于命名空间解析的指定前缀和命名空间映射计算 XPath 数据绑定表达式，并返回实现 IEnumerable 接口的节点集合。

事件

AbortTransaction	当用户结束交易时发生。
CommitTransaction	当事务完成时发生。
DataBinding	当服务器控件绑定到数据源时发生。 (继承自 Control)
Disposed	当从内存释放服务器控件时发生，这是请求 ASP.NET 页时服务器控件生存期的最后阶段。 (继承自 Control)
Error	当引发未经处理的异常时发生。
Init	当服务器控件初始化时发生；初始化是控件生存期的第一步。 (继承自 Control)
Load	当服务器控件加载到 Page 对象中时发生。 (继承自 Control)
PreRender	在加载 Control 对象之后、呈现之前发生。 (继承自 Control)
Unload	当服务器控件从内存中卸载时发生。 (继承自 Control)

显式接口实现

IControlBuilderAccessor.ControlBuilder	有关此成员的说明，请参见 ControlBuilder。 (继承自 Control)
IControlDesignerAccessor.GetDesignModeState()	有关此成员的说明，请参见 GetDesignModeState()。 (继承自 Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary)	有关此成员的说明，请参见 SetDesignModeState(IDictionary)。 (继承自 Control)
IControlDesignerAccessor.SetOwnerControl(Control)	有关此成员的说明，请参见 SetOwnerControl(Control)。 (继承自 Control)
IControlDesignerAccessor.UserData	有关此成员的说明，请参见 UserData。 (继承自 Control)
IDataBindingsAccessor.DataBindings	有关此成员的说明，请参见 DataBindings。 (继承自 Control)
IDataBindingsAccessor.HasDataBindings	有关此成员的说明，请参见 HasDataBindings。 (继承自 Control)
IExpressionsAccessor.Expressions	有关此成员的说明，请参见 Expressions。 (继承自 Control)
IExpressionsAccessor.HasExpressions	有关此成员的说明，请参见 HasExpressions。 (继承自 Control)
IFilterResolutionService.CompareFilters(String, String)	返回一个值，该值指示在两个指定设备筛选器之间是否存在父/子关系。
IFilterResolutionService.EvaluateFilter(String)	返回一个值，该值指示指定的筛选器是否为当前筛选器对象的其中一个类型。
IParserAccessor.AddParsedSubObject(Object)	有关此成员的说明，请参见 AddParsedSubObject(Object)。 (继承自 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)	为指定数据控件启用动态数据行为。

另请参阅

• Page
• UserControl