TemplateDefinition Class

.NET Framework (current version)

Other Versions

Provides properties and methods that define a template element in a Web server control at design time.

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

Inheritance Hierarchy

System::Object
System.Web.UI.Design::DesignerObject
System.Web.UI.Design::TemplateDefinition

Syntax

C++

public ref class TemplateDefinition : DesignerObject

Constructors

	Name	Description
	TemplateDefinition(ControlDesigner^, String^, Object^, String^)	Initializes a new instance of the TemplateDefinition class, using the provided designer, template name, template, and property name.
	TemplateDefinition(ControlDesigner^, String^, Object^, String^, Boolean)	Initializes a new instance of the TemplateDefinition class, using the provided designer, template name, template, property name, and whether to limit the template contents to Web server controls.
	TemplateDefinition(ControlDesigner^, String^, Object^, String^, Style^)	Initializes a new instance of the TemplateDefinition class, using the provided designer, template name, template, property name, and Style object.
	TemplateDefinition(ControlDesigner^, String^, Object^, String^, Style^, Boolean)	Initializes a new instance of the TemplateDefinition class, using the provided designer, template name, template, property name, Style object, and whether to limit content to Web server controls.

Properties

	Name	Description
	AllowEditing	Gets a value that indicates whether the template should enable editing of its contents.
	Content	Gets or sets the HTML markup representing the content of the template.
	Designer	Gets the associated designer component.(Inherited from DesignerObject.)
	Name	Gets the name of the object.(Inherited from DesignerObject.)
	Properties	Gets the object's properties.(Inherited from DesignerObject.)
	ServerControlsOnly	Retrieves a value indicating whether the template should limit content to Web server controls, as set in the TemplateDefinition constructor. This property is read-only.
	Style	Retrieves the style that should be applied to the template as set in the TemplateDefinition constructor. This property is read-only.
	SupportsDataBinding	Retrieves or sets a value indicating whether the template supports data binding.
	TemplatedObject	Retrieves the component in which the template resides. This property is read-only.
	TemplatePropertyName	Retrieves the property name for the template that the design host should display in the property grid.

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetService(Type^)	Gets a service from the design host, as identified by the provided type.(Inherited from DesignerObject.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	IServiceProvider::GetService(Type^)	For a description of this member, see IServiceProvider::GetService.(Inherited from DesignerObject.)

The TemplateDefinition class provides a base template definition class that can be inherited from and extended for a control designer to use in providing support for templated controls in a design host such as Visual Studio 2005. A design host uses the properties and methods of the TemplateDefinition class to facilitate creating and editing a template at design time.

Examples

The following code example demonstrates how to derive a custom class from the ControlDesigner class. This control designer supports a control with four possible templates.

To try it, add a reference to the System.Design.dll assembly, compile the code, and then, in a design host such as Visual Studio 2005, look at the page in Design view. Select the control, click the action list to select a template to modify, and then use the drag-and-drop feature to move controls into the template.

C++

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

<%@ Page Language="VB" %>
<%@ Register TagPrefix="aspSample" 
    Namespace="ASPNet.Design.Samples" %>

<!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>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>

       <aspSample:TemplateGroupsSample runat="server" ID="TGSample1">
       </aspSample:TemplateGroupsSample>

    </div>
    </form>
</body>
</html>

Version Information

.NET Framework
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.