[原创]FineUI秘密花园（二十九） — 用户控件概述

这里的用户控件指的是继承自System.Web.UI.UserControl的控件，由于本质上用户控件属于Asp.Net，所以可以直接放在form标签或者ContentPanel控件中。后来FineUI增加了UserControlConnector控件，可以使用户控件方便地参与页面布局。本篇文章会详细描述使用UserControlConnector的用户控件与直接放在ContentPanel中的用户控件的区别。

创建一个包含自定义属性的用户控件

我们将要创建的用户控件如下图所示：

这个用户控件非常简单，只包含一个面板和一个文本，ASPX标签如下所示：

<ext:Panel runat="server" ID="Panel1" BodyPadding="5px" Title="用户控件/面板一">
    <Items>
        <ext:Label runat="server" ID="labUserInfo">
        </ext:Label>
    </Items>
</ext:Panel>

来看下用户控件的后台代码：

protected void Page_Load(object sender, EventArgs e)
{
    LoadData();
}

private void LoadData()
{
    labUserInfo.Text = String.Format("{0}今年{1}岁，住在{2}。", UserName, UserAge, UserCountry);

    if (!String.IsNullOrEmpty(Properties))
    {
        Panel1.RecoverPropertiesFromJObject(JObject.Parse(Properties));
    }
}


private string userName;
private int userAge;
private string userCountry;
private string properties;

public string Properties
{
    get { return properties; }
    set { properties = value; }
}

public string UserName
{
    get { return userName; }
    set { userName = value; }
}

public int UserAge
{
    get { return userAge; }
    set { userAge = value; }
}

public string UserCountry
{
    get { return userCountry; }
    set { userCountry = value; }
}

从上面代码可以看出，我们定义了四个属性：

• UserName：用户名
• UserAge：用户年龄
• UserCountry：用户所在地区
• Properties：JSON定义的面板属性列表（比如：{BoxMargin:"0",BoxFlex:1}），可以通过RecoverPropertiesFromJObject来恢复。

在ContentPanel中添加用户控件

在ContentPanel中使用用户控件非常简单，由于ContentPanel本来就是用来放置非FineUI的一个特殊控件，来看下代码：

<ext:ContentPanel runat="server" ID="Panel1" EnableBackgroundColor="true" Width="600px"
    Height="150px" Title="页面/面板一（ContentPanel->UserInfoControl）">
    <uc1:UserInfoControl ID="UserInfoControl1" UserName="陈萍萍" UserAge="20" UserCountry="合肥"
        runat="server" />
</ext:ContentPanel>

显示效果：

分析下生成的HTML代码：

<div id="Panel1_wrapper">
    <div id="Panel1_content">
        <div id="Panel1_UserInfoControl1_Panel1_wrapper"></div>
    </div>
</div>

<script>
var x2 = new Ext.Panel({
    id: "Panel1_UserInfoControl1_Panel1",
    renderTo: "Panel1_UserInfoControl1_Panel1_wrapper",
    items: [x1],
    title: "用户控件/面板一"
});
var x0 = new Ext.Panel({
    id: "Panel1",
    renderTo: "Panel1_wrapper",
    contentEl: "Panel1_content",
    title: "页面/面板一（ContentPanel->UserInfoControl）"
});
</script>

可以看出，此时用户控件是直接渲染到 Panel1_UserInfoControl1_Panel1_wrapper 这个DIV中，而这个DIV位于Panel1面板中。

使用UserControlConnector添加用户控件

<ext:Panel runat="server" ID="Panel2" EnableBackgroundColor="true" Width="600px"
    Height="150px" Title="页面/面板二（Panel->UserControlConnector->UserInfoControl）">
    <Items>
        <ext:UserControlConnector runat="server">
            <uc1:UserInfoControl ID="UserInfoControl2" UserName="陈萍萍" UserAge="20" UserCountry="合肥"
                runat="server" />
        </ext:UserControlConnector>
    </Items>
</ext:Panel>

显示效果：

可以看到，使用UserControlConnector的显示效果和放在ContentPanel中的效果一样。但是两者有本质的区别，来看下生成的HTML代码：

<div id="Panel2_wrapper"></div>

<script>
var x5 = new Ext.Panel({
    id: "Panel2_ctl00_UserInfoControl2_Panel1",
    items: [x6],
    title: "用户控件/面板一"
});
var x8 = new Ext.Panel({
    id: "Panel2",
    renderTo: "Panel2_wrapper",
    items: [x5],
    title: "页面/面板二（Panel->UserControlConnector->UserInfoControl）"
});
</script>

此时，用户控件不是直接被渲染到页面上的DIV中，而是作为Panel2的items属性（items: [x5]），也就是说用户控件的渲染是由父控件控制的。

这种本质的区别也正是FineUI所追求的，由于用户控件的渲染是由父控件控制的，所以可以很方便的参与页面布局，比如改造上面的例子：

<ext:Panel runat="server" ID="Panel3" EnableBackgroundColor="true" Width="600px"
    Height="150px" Layout="Fit" Title="页面/面板三（Layout=Fit, Panel->UserControlConnector->UserInfoControl）">
    <Items>
        <ext:UserControlConnector runat="server">
            <uc1:UserInfoControl ID="UserInfoControl3" UserName="陈萍萍" UserAge="20" UserCountry="合肥"
                runat="server" />
        </ext:UserControlConnector>
    </Items>
</ext:Panel>

这个示例和上一个例子的唯一区别就是布局的使用（Layout=Fit），生成的界面效果确实完全不同的：

可以看到，用户控件参与到了页面布局，此时完全充满了外部的面板。而这种效果是ContentPanel所无法实现的。

动态添加用户控件

那么如何通过动态添加用户控件的方式来实现上一个例子呢：

<ext:Panel runat="server" ID="Panel3" EnableBackgroundColor="true" Width="600px"
    Height="150px" Layout="Fit" Title="页面/面板三（Layout=Fit, Panel->UserControlConnector->UserInfoControl）">
</ext:Panel>

protected void Page_Init(object sender, EventArgs e)
{
    UserControlConnector ctrlConnector2 = new UserControlConnector();
    Panel3.Items.Add(ctrlConnector2);
    ctrlConnector2.Controls.Add(CreateANewUserControl());
}

private UserInfoControl CreateANewUserControl()
{
    UserInfoControl ctrl = LoadControl("~/usercontrol/UserInfoControl.ascx") as UserInfoControl;
    ctrl.UserName = "陈萍萍";
    ctrl.UserAge = 20;
    ctrl.UserCountry = "合肥";

    return ctrl;
}

需要注意的有如下几点：

• 动态添加控件的代码放在Page_Init中，在前面《表格之动态创建列》中有详细描述；
• 通过LoadControl来动态创建用户控件。

用户控件参与复杂的页面布局

上个例子使用了Fit布局，下面的例子会使用更加复杂的布局VBox，先看一个简单的示例：

<ext:Panel runat="server" ID="Panel1" EnableBackgroundColor="true" Width="600px"
    Height="200px" Layout="VBox" BoxConfigAlign="Stretch" BoxConfigPosition="Start"
    BoxConfigPadding="5" BoxConfigChildMargin="0 0 5 0" Title="页面/面板一（Layout=VBox, Panel->(UserControlConnector->UserInfoControl,Panel)）">
    <Items>
        <ext:UserControlConnector ID="UserControlConnector1" runat="server">
            <uc1:UserInfoControl ID="UserInfoControl1" UserName="陈萍萍" UserAge="20" UserCountry="合肥"
                runat="server" />
        </ext:UserControlConnector>
        <ext:Panel runat="server" ID="Panel3" BodyPadding="5px" BoxFlex="1" BoxMargin="0"
            Title="页面/面板二">
            <Items>
                <ext:Label runat="server" Text="胡斐今年22岁，住在驻马店。">
                </ext:Label>
            </Items>
        </ext:Panel>
    </Items>
</ext:Panel>

在这个例子中，Panel1包含两个子控件，第一个控件是一个用户控件（由于没有应用布局属性，所以用户控件的高度将是默认的高度），另一个控件使用了布局属性BoxFlex=1，也就是说占据剩余的全部高度。页面显示效果：

为了实现相同的效果，我们也可以使用用户控件取代上例的第二个子控件，如下所示：

<ext:Panel runat="server" ID="Panel2" EnableBackgroundColor="true" Width="600px"
    Height="200px" Layout="VBox" BoxConfigAlign="Stretch" BoxConfigPosition="Start"
    BoxConfigPadding="5" BoxConfigChildMargin="0 0 5 0" Title="页面/面板一">
    <Items>
        <ext:UserControlConnector ID="UserControlConnector2" runat="server">
            <uc1:UserInfoControl ID="UserInfoControl2" UserName="陈萍萍" UserAge="20" UserCountry="合肥"
                runat="server" />
        </ext:UserControlConnector>
        <ext:UserControlConnector ID="UserControlConnector3" runat="server">
            <uc1:UserInfoControl ID="UserInfoControl3" Properties="{BoxMargin:'0',BoxFlex:1}" UserName="胡斐" UserAge="22" UserCountry="驻马店"
                runat="server" />
        </ext:UserControlConnector>
    </Items>
</ext:Panel>

要特别注意第二个用户控件的Properties属性（这个是我们自定义的），这是一个JSON字符串表示的对象，包含两个属于面板的属性BoxMargin和BoxFlex，在前面我们已经看到这两个属性被最终应用到用户控件中的面板上。

其实UserControlConnector可以包含多个子控件，因此上例可以简化为：

<ext:Panel runat="server" ID="Panel4" EnableBackgroundColor="true" Width="600px"
    Height="200px" Layout="VBox" BoxConfigAlign="Stretch" BoxConfigPosition="Start"
    BoxConfigPadding="5" BoxConfigChildMargin="0 0 5 0" Title="页面/面板二">
    <Items>
        <ext:UserControlConnector ID="UserControlConnector4" runat="server">
            <uc1:UserInfoControl ID="UserInfoControl4" UserName="陈萍萍" UserAge="20" UserCountry="合肥"
                runat="server" />
            <uc1:UserInfoControl ID="UserInfoControl5" UserName="胡斐" UserAge="22" UserCountry="驻马店"
                runat="server" />
        </ext:UserControlConnector>
    </Items>
</ext:Panel>

此时，对第二个用户控件Properties属性的设置是在后台进行的：

protected void Page_Load(object sender, EventArgs e)
{
    if (!IsPostBack)
    {
        LoadData();
    }
}

private void LoadData()
{
    JObject jo = new JObject();
    jo.Add("BoxMargin", "0");
    jo.Add("BoxFlex", 1);
    UserInfoControl5.Properties = jo.ToString(Formatting.None);
}

小结

用户控件有时非常实用，特别是对于一些需要在多个地方重用UI逻辑。而FineUI提供的UserControlConnector让用户控件可以很方便的参与页面布局，从而在重用UI逻辑的同时保持页面的美观一致。

注：《FineUI秘密花园》系列文章由三生石上原创，博客园首发，转载请注明出处。文章目录 官方论坛