动手做ASP.NET 2.0服务器端控件——AutoCheckTreeView（二）接口设计

 感谢谭振林先生所著《道不远人——深入解析ASP.NET 2.0控件开发》

 

讨论完了功能，我们来思考一下这个控件应该怎么设计。

1，给控件取个名字吧，因为一开始小凡只是考虑了自动勾选功能，所以就叫它AutoCheckTreeView。

2，显然继承自TreeView要比重新做一个更方便，那好，AutoCheckTreeView : TreeView就这么决定了。

3，它要开放一些什么新增接口吗？想一下，有的时候需要自动勾选功能，有的时候不需要自动勾选，那应该留下一个开关属性。

4，数据绑定，那比如要重载DataSource属性和DataBind()方法喽。

5，我们不能要求用户必须以规定的格式数据源来绑定我们的控件，所以，我们需要用户告诉我们，哪个字段或者属性代表主键，哪个字段或者属性代表父主键，并且就像DropDownList一样，要有一个TextMember来告诉我们到时候节点显示哪个字段里面的内容。

6，如果绑定的数据源是DataSet，那我们还需要知道是绑定其中是哪个表。

7，为了节省用户劳动，我们可以把节点选择后的动作TreeNodeSelectAction添加作为一个公开属性，当绑定数据后，我们就可以把节点生成为该类型。

因此，所有的接口属性和公开方法就是如下：

1. #region 变量
3.         private string dataPropertyName = String.Empty;
5.         /// <summary>
6.         /// 获取和设置单条数据中用于结构关系的列名或者属性名
7.         /// </summary>
8.         [Description("单条数据中用于结构关系的列名或者属性名"), DefaultValue("")]
9.         public string DataPropertyName
10.         {
11.             get
12.             {
13.                 return ViewState["dataPropertyName"] == null ? dataPropertyName : ViewState["dataPropertyName"].ToString();
14.             }
15.             set
16.             {
17.                 dataPropertyName = value;
18.                 ViewState["dataPropertyName"] = value;
19.             }
20.         }
22.         private string dataParentPropertyName = String.Empty;
24.         /// <summary>
25.         /// 获取和设置单条数据中用于结构关系的父数据列名或者属性名
26.         /// </summary>
27.         [Description("单条数据中用于结构关系的父数据列名或者属性名"), DefaultValue("")]
28.         public string DataParentPropertyName
29.         {
30.             get
31.             {
32.                 return ViewState["dataParentPropertyName"] == null ? dataParentPropertyName : ViewState["dataParentPropertyName"].ToString();
33.             }
34.             set
35.             {
36.                 dataParentPropertyName = value;
37.                 ViewState["dataParentPropertyName"] = value;
38.             }
39.         }
41.         private string tableName = String.Empty;
43.         /// <summary>
44.         /// 获取和设置表名称，用于当数据源为DataSet类型时
45.         /// </summary>
46.         [Description("表名称，用于当数据源为DataSet类型时"), DefaultValue("")]
47.         public string TableName
48.         {
49.             get
50.             {
51.                 return ViewState["tableName"] == null ? tableName : ViewState["tableName"].ToString();
52.             }
53.             set
54.             {
55.                 tableName = value;
56.                 ViewState["tableName"] = value;
57.             }
58.         }
60.         private string textMember = String.Empty;
62.         /// <summary>
63.         /// 获取和设置数据绑定时用户设置TEXT值的字段或属性名
64.         /// </summary>
65.         [Description("数据绑定时用户设置TEXT值的字段或属性名"), DefaultValue("")]
66.         public string TextMember
67.         {
68.             get
69.             {
70.                 return ViewState["textMember"] == null ? textMember : ViewState["textMember"].ToString();
71.             }
72.             set
73.             {
74.                 textMember = value;
75.                 ViewState["textMember"] = value;
76.             }
77.         }
79.         private Object dataSource = null;
81.         /// <summary>
82.         /// 设置和获取数据源，已重写
83.         /// </summary>
84.         [Description("数据源，已重写"), DefaultValue(null)]
85.         public new Object DataSource
86.         {
87.             get
88.             {
89.                 return ViewState["dataSource"] == null ? dataSource : ViewState["dataSource"];
90.             }
91.             set
92.             {
93.                 dataSource = value;
94.                 ViewState["dataSource"] = value;
95.             }
96.         }
98.         TreeNodeSelectAction nodeSelectAction = TreeNodeSelectAction.Select;
100.         /// <summary>
101.         /// 设置和获取树节点选择后将引发事件
102.         /// </summary>
103.         [Description("树节点选择后将引发事件"), DefaultValue(TreeNodeSelectAction.Select)]
104.         public TreeNodeSelectAction NodeSelectAction
105.         {
106.             get
107.             {
108.                 return ViewState["nodeSelectAction"] == null ? nodeSelectAction : (TreeNodeSelectAction)ViewState["nodeSelectAction"];
109.             }
110.             set
111.             {
112.                 nodeSelectAction = value;
113.                 ViewState["nodeSelectAction"] = value;
114.             }
115.         }
117.         private bool isAutoCheck = false;
119.         /// <summary>
120.         /// 设置和获取是否自动改变父子节点勾选状态
121.         /// </summary>
122.         [Description("是否自动改变父子节点勾选状态"), DefaultValue(false)]
123.         public bool IsAutoCheck
124.         {
125.             get
126.             {
127.                 return ViewState["isAutoCheck"] == null ? isAutoCheck : (bool)ViewState["isAutoCheck"];
128.             }
129.             set
130.             {
131.                 isAutoCheck = value;
132.                 ViewState["isAutoCheck"] = value;
133.             }
134.         }
136.         #endregion

 

1.         /// <summary>
2.         /// 将数据源进行绑定并显示
3.         /// </summary>
4.         public void BindData()

幸好TreeView是支持ViewState的，我们要将这些属性值信息记录在ViewState中，这样页面回传之后就不需要用户重新赋值绑定了。