C# Web控件与数据感应之 ListControl 类

关于数据感应

ListControl 类类型控件

范例运行环境

数据感应通用方法

设计

实现

调用示例

数据源

调用

小结

关于数据感应

数据感应也即数据捆绑，是一种动态的，Web控件与数据源之间的交互，诸如 System.Web.UI.WebControls 里的 DropDownList控件、ListBox控件，又如 System.Web.UI.HtmlControls 中的 HtmlSelect控件，均可以与数据源进行捆绑并显示。用于数据感应的数据源有多种，本文将主要介绍与数据库提取数据并捆绑控件为例，讲解C#创建一些通用方法，如何捆绑数据源到 ListControl 类类型控件上。

ListControl 类类型控件

在这里我们以 System.Web.UI.WebControls.DropDownList 控件为例，其表示允许用户从下拉列表中选择单个项的控件，包括显示的值（ListItem.Text）和存储的值（ListItem.Value），类似的还有 ListBox控件，在这里我们统称为 ListControl 类类型控件，只是它们的 UI 呈现和显示方式不同而已。

范例运行环境

操作系统： Windows Server 2019 DataCenter

.net版本： .netFramework4.7.1 或以上

开发工具：VS2019 C#

数据提取：在这里我们以能够支持 Oracle 9i、MS SQL Server 2016、国产达梦数据 8 的通用数据库内容提取方法为例，生成数据源需要利用 ADO.NET 中的数据提供者对象包括IDbConnection、IDbCommand、IDbDataParameter等，如何使用这些对象请参考我的文章：

《C#实现 IDbConnection / IDbCommand 等相关通用数据接口》

数据感应通用方法

设计

simpleDataList 方法可以下达SQL命令及配置相关参数，将数据源感应到指定的 ListControl 类控件上，其参数说明如下表：

序号	参数名	类型	说明
1	DbServerType	string	目前支持 "oracle"、 "dm8"，其它字符串均视为 MS SQL Server
2	strConn	string	对应数据库的连接字符串
3	sql	string	要执行的SQL语句命令行
4	paras	ArrayList	要赋值的参数对象，逐个添加到ArrayList里，请注意参数为实体数据参数对象，如 MS SQL Server ，请传递如下代码： ArrayList.Add(new SqlParameter("参数名",参数值));
5	keyfield	string	提取数据源成功时，用于捆绑ListItem.Value 的字段名
6	displayfield	string	提取数据源成功时，用于捆绑ListItem.Text 的字段名
7	_object	System.Web.UI.WebControls.ListControl	要捆绑的目标 ListControl 对象
8	allownull	bool	是否允许添加一个空项，指捆绑成功后是否还需要添加一个空项，该空项会自动增加到第一个选项（如Value为空，Text 显示为 “未选择” ），且处于默认选择状态，否则会自动默认为数据源的第一个选项
9	allownullvalue	string	当允许添加一个空项时（allownull为true），指定空项存储的 Value 值
10	allownulltext	string	当允许添加一个空项时（allownull为true），指定空项存储的 Text 值

实现

simpleDataList 方法完整代码如下：

public void simpleDataList(string DbServerType,string strConn,string sql,ArrayList paras,string keyfield,string displayfield,System.Web.UI.WebControls.ListControl _object,bool allownull,string allownullvalue,string allownulltext)
{System.Data.IDbConnection Conn=GetConnection(DbServerType,strConn);System.Data.IDbCommand Cmd=GetCommand(DbServerType,sql,paras,Conn);System.Data.IDataReader myDr=GetDataReader(DbServerType);try{Conn.Open();if (DbServerType.ToLower() == "dm8"){myDr = Cmd.ExecuteReader() as DmDataReader;}else{myDr = Cmd.ExecuteReader();}_object.DataSource = myDr;_object.DataTextField = displayfield;_object.DataValueField = keyfield;_object.DataBind();myDr.Close();}catch (SqlException){}finally{Conn.Close();Conn.Dispose();}if(allownull){_object.Items.Insert (0,new ListItem(allownulltext,allownullvalue));}
}//simpleDataListpublic System.Data.IDbConnection GetConnection(string DbServerType,string ConnectionString)
{IDbConnection con = null;switch (DbServerType.ToLower()){case "oracle":con = new OracleConnection(ConnectionString);break;case "dm8":con = new DmConnection(ConnectionString); break;default:con = new SqlConnection(ConnectionString);   break;}return con;}
public IDbCommand GetCommand(string dbservertype,string cmdText,ArrayList paras,IDbConnection con)
{IDbCommand cmd = null;switch (dbservertype.ToLower()){case "oracle": cmd = new OracleCommand(cmdText,(OracleConnection)con);break;case "dm8":cmd = new DmCommand(cmdText, (DmConnection)con);break;default:    cmd = new SqlCommand(cmdText,(SqlConnection)con);        break;}if(paras!=null){for(int i=0;i<paras.Count;i++){cmd.Parameters.Add(GetParameter(dbservertype,paras[i]));}}return cmd;
}
public System.Data.IDbDataParameter GetParameter(string dbservertype,object paras)
{IDbDataParameter para = null;switch (dbservertype.ToLower()){case "oracle": para =(OracleParameter)paras; break;case "dm8":para =  (DmParameter)paras;break;default: para =(SqlParameter)paras; break;}return para;
}

调用示例

数据源

我们以 MS SQL SERVER 为例，提取某一项目ID的所需上传附件列表，如下图数据显示：

表（pub_imagedescript）设计基本情况如下表：

序号	字段名	类型	说明	备注
1	xm_cid	uniqueidentifier	项目ID
2	value	nvarchar(100)	存储的值
3	text	nvarchar(100)	存储的显示值	用户可以看到的选择时的呈现值
4	sortid	int	排序号

调用

假设前端 UI 有 ID 为 x_p_refImageDescript 的 DropDownList 控件，则调用的示例代码如下：

ArrayList paras = new ArrayList();
string xm_cid="E5FB9BF5-6CB6-4792-B105-C4453028925D"; //项目ID
paras.Add(new SqlParameter("@cid", xm_cid));
simpledatalist("sqlserver","数据库连接串","select value,text from pub_ImageDescript where xm_cid=@cid order by sortid", paras, "text", "value", x_p_refImageDescript, true, "", "请选择一个附件");