TemplateControl Class

.NET Framework (current version)

Other Versions

Provides the Page class and the UserControl class with a base set of functionality.

Namespace: System.Web.UI
Assembly: System.Web (in System.Web.dll)

Inheritance Hierarchy

System.Object
System.Web.UI.Control
System.Web.UI.TemplateControl
System.Web.UI.Page
System.Web.UI.UserControl

Syntax

C++

JScript

No code example is currently available or this language may not be supported.

Constructors

	Name	Description
	TemplateControl()	Initializes a new instance of the TemplateControl class.

Properties

	Name	Description
	Adapter	Gets the browser-specific adapter for the control.(Inherited from Control.)
	AppRelativeTemplateSourceDirectory	Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.(Inherited from Control.)
	AppRelativeVirtualPath	Gets or sets the application-relative, virtual directory path to the file from which the control is parsed and compiled.
	AutoHandlers	Obsolete. This API supports the product infrastructure and is not intended to be used directly from your code. The AutoHandlers property has been deprecated in ASP.NET NET 2.0. It is used by generated classes and is not intended for use within your code.
	BindingContainer	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the control that contains this control's data binding.(Inherited from Control.)
	ChildControlsCreated	Gets a value that indicates whether the server control's child controls have been created.(Inherited from Control.)
	ClientID	Gets the control ID for HTML markup that is generated by ASP.NET.(Inherited from Control.)
	ClientIDMode	Gets or sets the algorithm that is used to generate the value of the ClientID property.(Inherited from Control.)
	ClientIDSeparator	Gets a character value representing the separator character used in the ClientID property.(Inherited from Control.)
	Context	Gets the HttpContext object associated with the server control for the current Web request.(Inherited from Control.)
	Controls	Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.(Inherited from Control.)
	DataItemContainer	Gets a reference to the naming container if the naming container implements IDataItemContainer.(Inherited from Control.)
	DataKeysContainer	Gets a reference to the naming container if the naming container implements IDataKeysControl.(Inherited from Control.)
	DesignMode	Gets a value indicating whether a control is being used on a design surface.(Inherited from Control.)
	EnableTheming	Gets or sets a Boolean value indicating whether themes apply to the control that is derived from the TemplateControl class. (Overrides Control.EnableTheming.)
	EnableViewState	Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.(Inherited from Control.)
	Events	Gets a list of event handler delegates for the control. This property is read-only.(Inherited from Control.)
	HasChildViewState	Gets a value indicating whether the current server control's child controls have any saved view-state settings.(Inherited from Control.)
	ID	Gets or sets the programmatic identifier assigned to the server control.(Inherited from Control.)
	IdSeparator	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the character used to separate control identifiers.(Inherited from Control.)
	IsChildControlStateCleared	Gets a value indicating whether controls contained within this control have control state.(Inherited from Control.)
	IsTrackingViewState	Gets a value that indicates whether the server control is saving changes to its view state.(Inherited from Control.)
	IsViewStateEnabled	Gets a value indicating whether view state is enabled for this control.(Inherited from Control.)
	LoadViewStateByID	Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
	NamingContainer	Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value.(Inherited from Control.)
	Page	Gets a reference to the Page instance that contains the server control.(Inherited from Control.)
	Parent	Gets a reference to the server control's parent control in the page control hierarchy.(Inherited from Control.)
	RenderingCompatibility	Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.(Inherited from Control.)
	Site	Gets information about the container that hosts the current control when rendered on a design surface.(Inherited from Control.)
	SkinID	Gets or sets the skin to apply to the control.(Inherited from Control.)
	SupportAutoEvents	This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether the TemplateControl control supports automatic events.
	TemplateControl	Gets or sets a reference to the template that contains this control. (Inherited from Control.)
	TemplateSourceDirectory	Gets the virtual directory of the Page or UserControl that contains the current server control.(Inherited from Control.)
	UniqueID	Gets the unique, hierarchically qualified identifier for the server control.(Inherited from Control.)
	ValidateRequestMode	Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.(Inherited from Control.)
	ViewState	Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.(Inherited from Control.)
	ViewStateIgnoresCase	Gets a value that indicates whether the StateBag object is case-insensitive.(Inherited from Control.)
	ViewStateMode	Gets or sets the view-state mode of this control.(Inherited from Control.)
	Visible	Gets or sets a value that indicates whether a server control is rendered as UI on the page.(Inherited from Control.)

Methods

	Name	Description
	AddedControl(Control, Int32)	Called after a child control is added to the Controls collection of the Control object.(Inherited from Control.)
	AddParsedSubObject(Object)	Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.(Inherited from Control.)
	ApplyStyleSheetSkin(Page)	Applies the style properties defined in the page style sheet to the control.(Inherited from Control.)
	BeginRenderTracing(TextWriter, Object)	Begins design-time tracing of rendering data.(Inherited from Control.)
	BuildProfileTree(String, Boolean)	This API supports the product infrastructure and is not intended to be used directly from your code. Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.(Inherited from Control.)
	ClearCachedClientID()	This API supports the product infrastructure and is not intended to be used directly from your code. Sets the cached ClientID value to null.(Inherited from Control.)
	ClearChildControlState()	Deletes the control-state information for the server control's child controls. (Inherited from Control.)
	ClearChildState()	Deletes the view-state and control-state information for all the server control's child controls.(Inherited from Control.)
	ClearChildViewState()	Deletes the view-state information for all the server control's child controls.(Inherited from Control.)
	ClearEffectiveClientIDMode()	This API supports the product infrastructure and is not intended to be used directly from your code. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.(Inherited from Control.)
	Construct()	Performs design-time logic.
	CreateChildControls()	Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.(Inherited from Control.)
	CreateControlCollection()	Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.(Inherited from Control.)
	CreateResourceBasedLiteralControl(Int32, Int32, Boolean)	This API supports the product infrastructure and is not intended to be used directly from your code. Accesses literal strings stored in a resource. The CreateResourceBasedLiteralControl method is not intended for use from within your code.
	DataBind()	Binds a data source to the invoked server control and all its child controls.(Inherited from Control.)
	DataBind(Boolean)	Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.)
	DataBindChildren()	Binds a data source to the server control's child controls.(Inherited from Control.)
	Dispose()	Enables a server control to perform final clean up before it is released from memory.(Inherited from Control.)
	EndRenderTracing(TextWriter, Object)	Ends design-time tracing of rendering data.(Inherited from Control.)
	EnsureChildControls()	Determines whether the server control contains child controls. If it does not, it creates child controls.(Inherited from Control.)
	EnsureID()	Creates an identifier for controls that do not have an identifier assigned.(Inherited from Control.)
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Eval(String)	Evaluates a data-binding expression.
	Eval(String, String)	Evaluates a data-binding expression using the specified format string to display the result.
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	FindControl(String)	Searches the current naming container for a server control with the specified id parameter.(Inherited from Control.)
	FindControl(String, Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.(Inherited from Control.)
	Focus()	Sets input focus to a control.(Inherited from Control.)
	FrameworkInitialize()	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes the control that is derived from the TemplateControl class.
	GetDesignModeState()	This API supports the product infrastructure and is not intended to be used directly from your code. Gets design-time data for a control.(Inherited from Control.)
	GetGlobalResourceObject(String, String)	Gets an application-level resource object based on the specified ClassKey and ResourceKey properties.
	GetGlobalResourceObject(String, String, Type, String)	Gets an application-level resource object based on the specified ClassKey and ResourceKey properties, object type, and property name of the resource.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetLocalResourceObject(String)	Gets a page-level resource object based on the specified ResourceKey property.
	GetLocalResourceObject(String, Type, String)	Gets a page-level resource object based on the specified ResourceKey property, object type, and property name.
	GetRouteUrl(Object)	Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)
	GetRouteUrl(RouteValueDictionary)	Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)
	GetRouteUrl(String, Object)	Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)
	GetRouteUrl(String, RouteValueDictionary)	Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	GetUniqueIDRelativeTo(Control)	Returns the prefixed portion of the UniqueID property of the specified control.(Inherited from Control.)
	HasControls()	Determines if the server control contains any child controls.(Inherited from Control.)
	HasEvents()	Returns a value indicating whether events are registered for the control or any child controls.(Inherited from Control.)
	IsLiteralContent()	This API supports the product infrastructure and is not intended to be used directly from your code. Determines if the server control holds only literal content.(Inherited from Control.)
	LoadControl(String)	Loads a Control object from a file based on a specified virtual path.
	LoadControl(Type, Object[])	Loads a Control object based on a specified type and constructor parameters.
	LoadControlState(Object)	Restores control-state information from a previous page request that was saved by the SaveControlState method.(Inherited from Control.)
	LoadTemplate(String)	Obtains an instance of the ITemplate interface from an external file.
	LoadViewState(Object)	Restores view-state information from a previous page request that was saved by the SaveViewState method.(Inherited from Control.)
	MapPathSecure(String)	Retrieves the physical path that a virtual path, either absolute or relative, maps to.(Inherited from Control.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	OnAbortTransaction(EventArgs)	Raises the AbortTransaction event.
	OnBubbleEvent(Object, EventArgs)	Determines whether the event for the server control is passed up the page's UI server control hierarchy.(Inherited from Control.)
	OnCommitTransaction(EventArgs)	Raises the CommitTransaction event.
	OnDataBinding(EventArgs)	Raises the DataBinding event.(Inherited from Control.)
	OnError(EventArgs)	Raises the Error event.
	OnInit(EventArgs)	Raises the Init event.(Inherited from Control.)
	OnLoad(EventArgs)	Raises the Load event.(Inherited from Control.)
	OnPreRender(EventArgs)	Raises the PreRender event.(Inherited from Control.)
	OnUnload(EventArgs)	Raises the Unload event.(Inherited from Control.)
	OpenFile(String)	Gets a Stream used to read a file.(Inherited from Control.)
	ParseControl(String)	Parses an input string into a Control object on the Web Forms page or user control.
	ParseControl(String, Boolean)	Parses an input string into a Control object on the ASP.NET Web page or user control.
	RaiseBubbleEvent(Object, EventArgs)	Assigns any sources of the event and its information to the control's parent.(Inherited from Control.)
	ReadStringResource()	This API supports the product infrastructure and is not intended to be used directly from your code. Reads a string resource. The ReadStringResource method is not intended for use from within your code.
	ReadStringResource(Type)	This API supports the product infrastructure and is not intended to be used directly from your code. Reads a string resource. The ReadStringResource method is not intended for use from within your code.
	RemovedControl(Control)	Called after a child control is removed from the Controls collection of the Control object.(Inherited from Control.)
	Render(HtmlTextWriter)	Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client.(Inherited from Control.)
	RenderChildren(HtmlTextWriter)	Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.(Inherited from Control.)
	RenderControl(HtmlTextWriter)	Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.(Inherited from Control.)
	RenderControl(HtmlTextWriter, ControlAdapter)	Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.(Inherited from Control.)
	ResolveAdapter()	Gets the control adapter responsible for rendering the specified control.(Inherited from Control.)
	ResolveClientUrl(String)	Gets a URL that can be used by the browser.(Inherited from Control.)
	ResolveUrl(String)	Converts a URL into one that is usable on the requesting client.(Inherited from Control.)
	SaveControlState()	Saves any server control state changes that have occurred since the time the page was posted back to the server.(Inherited from Control.)
	SaveViewState()	Saves any server control view-state changes that have occurred since the time the page was posted back to the server.(Inherited from Control.)
	SetDesignModeState(IDictionary)	Sets design-time data for a control.(Inherited from Control.)
	SetRenderMethodDelegate(RenderMethod)	This API supports the product infrastructure and is not intended to be used directly from your code. Assigns an event handler delegate to render the server control and its content into its parent control.(Inherited from Control.)
	SetStringResourcePointer(Object, Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. Sets a pointer to a string resource. The SetStringResourcePointer method is used by generated classes and is not intended for use from within your code.
	SetTraceData(Object, Object)	Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.(Inherited from Control.)
	SetTraceData(Object, Object, Object)	Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.(Inherited from Control.)
	TestDeviceFilter(String)	Returns a Boolean value indicating whether a device filter applies to the HTTP request.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	TrackViewState()	Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the Control.ViewState property.(Inherited from Control.)
	WriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean)	This API supports the product infrastructure and is not intended to be used directly from your code. Writes a resource string to an HtmlTextWriter control. The WriteUTF8ResourceString method is used by generated classes and is not intended for use from within your code.
	XPath(String)	Evaluates an XPath data-binding expression.
	XPath(String, IXmlNamespaceResolver)	Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution.
	XPath(String, String)	Evaluates an XPath data-binding expression using the specified format string to display the result.
	XPath(String, String, IXmlNamespaceResolver)	Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and the specified format string to display the result.
	XPathSelect(String)	Evaluates an XPath data-binding expression and returns a node collection that implements the IEnumerable interface.
	XPathSelect(String, IXmlNamespaceResolver)	Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and returns a node collection that implements the IEnumerable interface.

Events

	Name	Description
	AbortTransaction	Occurs when a user ends a transaction.
	CommitTransaction	Occurs when a transaction completes.
	DataBinding	Occurs when the server control binds to a data source.(Inherited from Control.)
	Disposed	Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.(Inherited from Control.)
	Error	Occurs when an unhandled exception is thrown.
	Init	Occurs when the server control is initialized, which is the first step in its lifecycle.(Inherited from Control.)
	Load	Occurs when the server control is loaded into the Page object.(Inherited from Control.)
	PreRender	Occurs after the Control object is loaded but prior to rendering.(Inherited from Control.)
	Unload	Occurs when the server control is unloaded from memory.(Inherited from Control.)

Explicit Interface Implementations

	Name	Description
	IControlDesignerAccessor.GetDesignModeState()	For a description of this member, see IControlDesignerAccessor.GetDesignModeState.(Inherited from Control.)
	IControlDesignerAccessor.SetDesignModeState(IDictionary)	For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.)
	IControlDesignerAccessor.SetOwnerControl(Control)	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.)
	IFilterResolutionService.CompareFilters(String, String)	This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether a parent/child relationship exists between two specified device filters.
	IFilterResolutionService.EvaluateFilter(String)	This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether the specified filter is a type of the current filter object.
	IParserAccessor.AddParsedSubObject(Object)	For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.)
	IControlBuilderAccessor.ControlBuilder	For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.)
	IControlDesignerAccessor.UserData	For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.)
	IDataBindingsAccessor.DataBindings	For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.)
	IDataBindingsAccessor.HasDataBindings	For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.)
	IExpressionsAccessor.Expressions	For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.)
	IExpressionsAccessor.HasExpressions	For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.)

Extension Methods

	Name	Description
	EnableDynamicData(Type)	Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)
	EnableDynamicData(Type, IDictionary<String, Object>)	Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)
	EnableDynamicData(Type, Object)	Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)
	FindDataSourceControl()	Returns the data source that is associated with the data control for the specified control.(Defined by DynamicDataExtensions.)
	FindFieldTemplate(String)	Returns the field template for the specified column in the specified control's naming container.(Defined by DynamicDataExtensions.)
	FindMetaTable()	Returns the metatable object for the containing data control.(Defined by DynamicDataExtensions.)
	GetDefaultValues()	Overloaded. Gets the collection of the default values for the specified data control.(Defined by DynamicDataExtensions.)
	GetMetaTable()	Overloaded. Gets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)
	SetMetaTable(MetaTable)	Overloaded. Sets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)
	SetMetaTable(MetaTable, IDictionary<String, Object>)	Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)
	SetMetaTable(MetaTable, Object)	Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)
	TryGetMetaTable(MetaTable)	Overloaded. Determines whether table metadata is available.(Defined by DynamicDataExtensions.)

Remarks

The TemplateControl class is an abstract class that provides common properties and methods for the Page class and the UserControl class. A new instance of the TemplateControl is not created directly.

The TemplateControl class defines methods supporting declarative data-binding expressions:

Use the Eval method for data-binding expression involving data sources, such as simple properties or expressions.
Use the XPath method for parsing and evaluating an XPath data-binding expression.
Use the XPathSelect method for data-binding against an expression containing an XPath select statement. The result is a node collection that implements the IEnumerable interface.

For more information on data-binding expression, see Data-Binding Expression Syntax and Binding to Databases.

The following code example demonstrates how to derive a control named MyControl from the TemplateControl class and override the Construct method. When MyControl is initialized, the overridden Construct method is called.