asp.net - 如何将模板添加到用户控件？

Question

这个问题之前有人问过

• Web 表单 :: VS 2008 中自定义模板化用户控件的设计时支持
• VS 2008 在 UserControl 中使用 ITemplate 并获得设计时渲染错误
• 如何在设计时显示 Web 用户控件的控件？
• UserControl ITemplate 属性设计时间错误 - 对大师来说很容易......

但再问一次也无妨：

如何UserControl在 ASP.net 中添加模板？

到目前为止没有什么效果

1. 从一个新的UserControl⁵开始，我称之为Contoso：

   public partial class Contoso: System.Web.UI.UserControl
   {
   }
   

   这将允许我们使用新控件：¹

   <Contoso>
       Stuff in here
   <Contoso>
   

2. 创建ContentTemplate类型的公共属性ITemplate：

   public partial class Contoso: System.Web.UI.UserControl
   {
      public ITemplate ContentTemplate { get; set; }
   }
   

   并向属性添加不确定数量的属性ContentTemplate：²

   //[ParseChildren(true)]
   [ParseChildren(true, "ContentTemplate")]
   //[ParseChildren(false)]
   public partial class Contoso: System.Web.UI.UserControl
   {
      [TemplateContainer(typeof(ContentContainer))]
      [TemplateInstance(TemplateInstance.Single)]
      [PersistenceMode(PersistenceMode.InnerProperty)]   
      //[PersistenceMode(PersistenceMode.InnerDefaultProperty)] 
      [Browsable(true)]
      //[Browsable(false)]
      [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)]
      //[DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
      public ITemplate ContentTemplate { get; set; }
   }
   

   这将允许我们添加<ContentTemplate>到我们的 aspx 文件中的控件：¹

   <Contoso>
      <ContentTemplate>
          Stuff in here
      </ContentTemplate>
   </Contoso>
   

3. 接下来我们需要通过在某处添加它来实际使用这些ContentTemplate东西。我们通过将它添加到我们的 UserControl 的内部div元素之一来做到这一点。

   从我们.aspx最初为空的文件开始：

   <%@ Control Language="C#" AutoEventWireup="true" CodeFile="Contoso.aspx.cs" Inherits="Contoso" %>
   

   div我们添加一个将保存我们的ContentTemplate东西的父母：

   <%@ Control Language="C#" AutoEventWireup="true" CodeFile="Contoso.aspx.cs" Inherits="Contoso" %>
   <div id="ContentDiv" runat="server"></div>
   

   然后我们在控件的InitContentTemplate期间将这些东西填充到该父级中：div

   public partial class Contoso: System.Web.UI.UserControl
   {
      protected override void OnInit(EventArgs e)
      {
         base.OnInit(e);
   
         //If there's content, then put it into our ContentDiv div
         if (this.ContentTemplate != null)
            this.ContentTemplate.InstantiateIn(ContentDiv);
      }
   
      [PersistenceModeAttribute(PersistenceMode.InnerProperty)]    
      [TemplateInstanceAttribute(TemplateInstance.Single)]
      [Browsable(true)]
      [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)]
      public ITemplate ContentTemplate { get; set; }
   }
   

4. 编辑：表明您的类实现INamingContainer：

   public partial class Contoso: System.Web.UI.UserControl: INamingContainer
   {
      protected override void OnInit(EventArgs e)
      {
         base.OnInit(e);
   
         //If there's content, then put it into our ContentDiv div
         if (this.ContentTemplate != null)
            this.ContentTemplate.InstantiateIn(ContentDiv);
      }
   
      [PersistenceModeAttribute(PersistenceMode.InnerProperty)]    
      [TemplateInstanceAttribute(TemplateInstance.Single)]
      [Browsable(true)]
      [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)]
      public ITemplate ContentTemplate { get; set; }
   }
   

   该INamingContainer接口没有任何成员，仅用于将您的UserControl类标记为某物。

5. 我们完成了³。我们现在可以在我们的 aspx 页面中使用这个控件。但首先我们需要在我们的 aspx 页面顶部“注册”它：

   <%@ Register src="Contoso.ascx" TagName="Contoso" tagprefix="uc" %>
   

   在哪里：

   • Contoso.ascx是ascx文件名
   • Contoso是我们将用来引用此用户控件的元素的名称
   • uc是我们必须放在前面的一些文本uc:Contoso（我uc用作user-control的缩写）

6. 将控件添加到我们的页面：

   <uc:Contoso ID="Crackers" runat="server">
       <ContentTemplate>
           Stuff goes here
       </ContentTemplate>
   </qwerty:Contoso>
   

我们完成了！⁴

编辑：忘记添加上述不起作用的原因。Visual Studio 显示错误：

创建控件时出错 - Crackers

类型“System.Web.UI.UserControl”没有名为“ContentTemplate”的公共属性

这是有道理的，因为UserControl没有一个名为的公共财产ContentTemplate——所以我很难责怪它。

系列

这个问题是正在进行的 Stackoverflow 系列“模板化用户控件”中的一个：

• 如何将模板添加到用户控件？
• 如何从 Control 继承，而不是 UserControl？
• UserControl 有 IsPostBack，但 Control 没有
• UserControl 没有名为 ContentTemplate 的公共属性
• 如何从 web.config 指定 CodeFileBaseClass？

奖金阅读

• 如何：创建模板化 ASP.NET 用户控件
• 使用 ASP.Net 2.0 创建模板化用户控件
• ASP.NET 中的模板化用户控件以获得更好的可维护性

脚注

• ¹你永远不能使用那种语法。这只是一种易于阅读和理解的形式。
• ²没有人知道要添加什么属性，或者为什么。添加或多或少的属性来品尝。
• ³未完成。完成了 UserControl，但不是我们的工作。
• ⁴未完成；它不起作用。
• ⁵在网站中（不是 Web 应用程序，不是在单独的程序集中）

Answer 1

好吧，我相信你几乎明白了。

顺便提一句。UserControl 不是使用 Visual Studio 设计器呈现的，但是当您运行应用程序时，该控件可以工作。如果您改用服务器控件，情况会有所不同，在这种情况下，控件会在 Visual Studio 设计器中正确显示

以下代码非常适合构建模板化用户控件和模板化服务器控件，但是，如果您想添加绑定功能，过程会略有不同，请查看

下载源代码

这是创建模板的代码UserControl。

简单输出

模板容器

public class MyTemplateContainer : Control, INamingContainer { }

ASPX 代码背后

protected void Page_Load(object sender, EventArgs e)
{
    // just to demonstrate using the contorl
    this.WebUserControl1.Controls.Add(new LiteralControl("<br />new control"));
}

ASPX

<%@ Register src="WebUserControl.ascx" tagname="WebUserControl" tagprefix="uc1" %>

    <uc1:WebUserControl ID="WebUserControl1" runat="server">
        <ContentTemplate>
            My Template<br />
            <asp:Label Text='Hello People' runat="server" ID="lblMessage" />
        </ContentTemplate>
    </uc1:WebUserControl>

背后的 ASCX 代码

public partial class WebUserControl : System.Web.UI.UserControl
{
    [TemplateContainer(typeof(MyTemplateContainer))]
    [TemplateInstance(TemplateInstance.Single)]
    [PersistenceMode(PersistenceMode.InnerProperty)]
    [Browsable(true)]
    [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)]
    public ITemplate ContentTemplate { get; set; }

    protected void Page_Init(object sender, EventArgs e)
    {
        this.myPlaceHolderTag.Controls.Clear();

        if (this.ContentTemplate != null)
        {
            var container = new MyTemplateContainer();

            this.ContentTemplate.InstantiateIn(container);
            this.myPlaceHolderTag.Controls.Add(container);
        }
        else
        {
            this.myPlaceHolderTag.Controls.Add(new LiteralControl("No template defined"));
        }
    }
}

澳交所

<%@ Control Language="C#" AutoEventWireup="true" CodeFile="WebUserControl.ascx.cs" Inherits="WebUserControl" %>

<asp:PlaceHolder runat="server" ID="myPlaceHolderTag" />

添加模板化服务器控件的代码

输出

ASPX

<%@ Register Namespace="MyControls" TagPrefix="my" %>

<my:MyServerControl runat="server" ID="myServerControl">
    <ContentTemplate>
        My Server templated control<br />
        <asp:Label Text="My Label" runat="server" />
    </ContentTemplate>
</my:MyServerControl>

模板容器

namespace MyControls
{
    [ToolboxItem(false)]
    public class MyTemplateContainer : Control, INamingContainer { } 
}

模板化服务器控制

namespace MyControls
{
    [ToolboxData("<{0}:MyServerControl runat=server >")]
    [ToolboxItem(true)]
    [ParseChildren(true)]
    // you can inherit from another control if you like, for example from the CompositeControl
    public class MyServerControl : Control, INamingContainer
    {
        [TemplateInstance(TemplateInstance.Multiple)]
        [TemplateContainer(typeof(MyTemplateContainer))]
        [PersistenceMode(PersistenceMode.InnerProperty)]
        [Browsable(true)]
        [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
        [DefaultValue(null)]
        public ITemplate ContentTemplate { get; set; }

        protected override void CreateChildControls()
        {
            var p = new Panel { ID = "myPanel", BackColor = Color.Silver, Width = new Unit("100%") };

            if (this.ContentTemplate == null)
            {
                p.Controls.Add(new LiteralControl("No content has been specified"));
            }
            else
            {
                var c = new MyTemplateContainer();

                this.ContentTemplate.InstantiateIn(c);
                p.Controls.Add(c);
            }

            this.Controls.Clear();
            this.Controls.Add(p);
        }

        public override void DataBind()
        {
            this.CreateChildControls();
            this.ChildControlsCreated = true;
            base.DataBind();
        }

        public override ControlCollection Controls
        {
            get
            {
                this.EnsureChildControls();
                return base.Controls;
            }
        }
    }
}

参考：

• 如何：创建模板化 ASP.NET 用户控件

• 构建模板化的自定义 ASP.NET 服务器控件

• 构建 DataBound 模板化自定义 ASP.NET 服务器控件