使用嵌套的可选控件创建自定义服务器控件

Question

我想创建一个自定义服务器控件VersionedContentControl ，它将允许我指定最终标记的不同变体。

用法示例：

<custom:VersionedContentControl runat="server" VersionToUse="2">
    <ContentVersions>
        <Content Version="1">
            <asp:HyperLink runat="server" ID="HomeLink" NavigateUrl="~/Default.aspx">Home</asp:HyperLink>
        </Content>
        <Content Version="2">
            <asp:LinkButton runat="server" ID="HomeLink" OnClick="GoHome">Home</asp:LinkButton>
        </Content>
        <Content Version="3">
            <custom:HomeLink runat="server" ID="HomeLink" />
        </Content>
    </ContentVersions>
</custom:VersionedContentControl>

使用上面的标记，我希望页面上将使用唯一的LinkButton控件。

很长的故事

我很难定义这个自定义控件。 我什至无法在MSDN上找到使用这样的嵌套控件的好例子。 相反，我不得不以这些博客文章为例：

• http://blog.spontaneouspublicity.com/child-collections-in-asp-net-custom-controls
• http://www.tomot.de/en-us/article/2/asp.net/how-to-create-an-asp.net-control-that-behaves-as-a-template-container-to-巢化内容通过加价

不幸的是，我尝试过的一切都失败了。 这是我目前拥有的：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.UI;

namespace CustomControls
{
    [ParseChildren(true)]
    [PersistChildren(false)]
    public class VersionedContentControl : Control, INamingContainer
    {
        public string VersionToUse { get; set; }

        [PersistenceMode(PersistenceMode.InnerProperty)]
        public IList<Content> ContentVersions { get; set; }

        protected override void OnInit(EventArgs e)
        {
            base.OnInit(e);
            var controlToUse = ContentVersions.Single(x => x.Version == VersionToUse);
            Controls.Clear();
            controlToUse.InstantiateIn(this);
        }
    }

    public class Content : ITemplate
    {
        public string Version { get; set; }

        public void InstantiateIn(Control container)
        {
            // I don't know what this method should do
        }
    }

    public class ContentVersionsList : List<Content> {}
}

即使我还没有实现InstantiateIn ，我所有内容的所有3个版本都显示在页面上。 它显示3个链接。

另外，除非为每个嵌套控件指定不同的ID属性值，否则我将无法使用该控件。 我不能全部使用"HomeLink" 。 我希望能够重复使用ID以便可以从后面的代码访问控件。

我意识到，通常情况下，禁止在页面上为多个控件指定重复的ID值。 但是，在有关System.Web.UI.MobileControls.DeviceSpecific的MSDN文档中 ，示例对嵌套控件使用重复的ID值。 实际上，该示例与我要执行的操作非常接近。 它基于移动设备兼容性过滤器而有所不同。

<mobile:Form id="Form1" runat="server">
    <mobile:DeviceSpecific Runat="server">
        <Choice Filter="isHTML32">
            <HeaderTemplate>
                <mobile:Label ID="Label1" Runat="server">
                    Header Template - HTML32</mobile:Label>
                <mobile:Command Runat="server">
                    Submit</mobile:Command>
            </HeaderTemplate>
            <FooterTemplate>
                <mobile:Label ID="Label2" Runat="server">
                    Footer Template</mobile:Label>
            </FooterTemplate>
        </Choice>
        <Choice>
            <HeaderTemplate>
                <mobile:Label ID="Label1" Runat="server">
                    Header Template - Default</mobile:Label>
                <mobile:Command ID="Command1" Runat="server">
                    Submit</mobile:Command>
            </HeaderTemplate>
            <FooterTemplate>
                <mobile:Label ID="Label2" Runat="server">
                    Footer Template</mobile:Label>
            </FooterTemplate>
        </Choice>
    </mobile:DeviceSpecific>
</mobile:Form>

最好查看这些控件的源代码，以了解它们如何完成此操作，但是不幸的是，它不是开源的。

我的问题

如何创建一个自定义服务器控件，其中包含嵌套控件列表，并且仅基于属性呈现一个嵌套控件？ 理想情况下，在单独的嵌套控件之间重用ID。

Answer 1

TL;博士

我最终使用了MultiView控件。 它不允许重复的ID，但可以满足我的所有其他要求，并且可以避免维护任何自定义代码。

我尝试了什么

我终于能够得到的东西与此代码的工作 ：

using System.Collections.Generic;
using System.Linq;
using System.Web.UI;

namespace CustomControls
{
    [ParseChildren(true)]
    [PersistChildren(false)]
    public class VersionedContent : Control
    {
        public string VersionToUse { get; set; }

        [PersistenceMode(PersistenceMode.InnerProperty)]
        [TemplateContainer(typeof(ContentContainer))]
        [TemplateInstance(TemplateInstance.Multiple)]
        public List<Content> ContentVersions { get; set; }

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

        public ContentContainer ContentContainer
        {
            get
            {
                EnsureChildControls();
                return _contentContainer;
            }
        } private ContentContainer _contentContainer;

        protected override void CreateChildControls()
        {
            var controlToUse = ContentVersions.Single(x => x.Version == VersionToUse);
            Controls.Clear();
            _contentContainer = new ContentContainer();
            controlToUse.InstantiateIn(_contentContainer);
            Controls.Add(_contentContainer);
        }
    }

    public class Content : Control, ITemplate
    {
        public string Version { get; set; }

        public void InstantiateIn(Control container)
        {
            container.Controls.Add(this);
        }
    }

    public class ContentContainer : Control { }
}

这使我可以像这样使用控件：

<custom:VersionedContent ID="VersionedContentControl" runat="server" VersionToUse="1">
    <ContentVersions>
        <custom:Content Version="1">
            <custom:MyControlV1 runat="server" />
        </custom:Content>
        <custom:Content Version="2">
            <custom:MyControlV2 runat="server" CustomProperty="Foo" />
        </custom:Content>
    </ContentVersions>
</custom:VersionedContent>

不幸的是，该解决方案有几个缺点。

• 即使我使用Template实例，也不允许在单独的“ Content部分中使用重复的ID
• ViewState处理不正确
  • PostBack无法正常工作
  • 验证根本不起作用

在查看了MultiView控件的反编译源代码（类似）之后，我意识到我必须使代码复杂得多才能使其按需工作。 我将获得只使用了唯一MultiView控制是可能能够使用重复的ID， 如果我甚至可以拿到工作。 我认为最好只是使用内置的MultiView控件。

Answer 2

protected override void RenderContents(HtmlTextWriter output)
        {

            output.Write("<div><div class=\"UserSectionHead\">");

            Label l = new Label() { Text = Label };
            TextBox t = new TextBox() { Text = Text };
            l.AssociatedControlID = t.ID;
            l.RenderControl(output);

            output.Write("</div><div class=\"UserSectionBody\"><div class=\"UserControlGroup\"><nobr>");

            t.RenderControl(output);

            output.Write("</nobr></div></div><div style=\"width:100%\" class=\"UserDottedLine\"></div>");

        }