MyControls组件使用手册.doc

MyControls组件使用手册文档最后更新时间：2011年3月21日 编写人：陈兴旺1. 组件功能介绍MyGridView：继承GridView，跟GridView使用方法相同，具备GridView原来的所有功能。扩展了自动生成列，合计列，固定行列等功能。MyTextBox：继承TextBox，跟TextBox使用方法相同，具备TextBox原来的所有功能。扩展了根据类型在失去焦点时进行类型验证，有数据类型：Varchar类型（字符串类型）；Text类型；Money类型（用于金额，会自动隔三位加对号）；Int类型（只能输入整数）；Float类型（只能输入整数和小数）；DateTime类型（用于日期类型，双击会弹出日期选择控件，会对日期类型进行校验）；DateAndTime类型（用于日期时间类型，双击会弹出日期选择控件，可能选择日期和时间，会对日期和时间进行校验）；Code类型（用于选择类型，设置CodeId时，双击会弹出对应的选择页面，不能手动输入）MyTreeView：继承TreeView，跟TreeView使用方法相同，具备TreeView原来的所有功能。扩展了级联选择功能。WebViewInput：视图录入控件。根据用户配置（在系统管理里可以配置），以MyTextBox和其他控件实现对数据库表的增加、修改和查看操作，可以自动实现类型和非空的校验。2. 配置项2.1. 直接依赖MyControls.dll文本框组件2.2. 间接依赖DBUtility.dll数据访问组件2.3. 名称空间MyControls2.4. 包含的类2.5. 包含的属性MyTextBox：TextTypeTextBox数据类型PagePath要弹出页面的路径仅类型为Code是有用CodeIdCodeId 部门为UM人员为UP其它与表SM_CodeCollect关联仅类型为Code是有用OnlyLeafOnlyLeaf 只能选择叶子节点仅类型为Code是有用Value对Text处理后的值WebViewInput：TableName表名ViewName视图名称。用于对一个表进行多种录入方式。ViewInputState控件操作模式（Add：增加模式；Modify：修改模式；View：查看模式；Search：搜索模式）CheckNullElement提交前进行验证的按钮ID。如果有多个要进行验证的按钮，ID之间有,分隔。格式：Button1,Button2ColumnCount表格的列数，只能是或者，默认为列。IDENTITY返回IDENTITY值，只有操作表格为自增长列，增加模式保存后才会产生。ViewWhere查看Where后的SQL。格式：=1 and 1=1AddFieldINSERT的字段部份。格式：Field1,Field2,AddValueINSERT的Value部份。格式：Value1,Value2,ModifySQLUPDATE的SET部份。格式：Field1=Value1,Field2=Value2,TableCssClass表格的样式NameCssClass标识列的单元格的样式TextCssClass内容列的单元格的样式SaveSql返回保存时的Sql，只有执行完Save()方法后才有值。2.6. 包含的方法WebViewInput：Add()增加模式Modify()修改模式返回：string 返回错误信息如果正确则返回空串。View()查看模式返回：string 返回错误信息如果正确则返回空串。UpateData(string FieldName, string FieldValue)给控件赋值里的一个控件赋值返回：string 返回错误信息如果正确则返回空串。参数：FieldName：字段名称；FieldValue：字段值。GetData(string FieldName)得到控件里的一个控件的值返回： string 返回字段值参数：FieldName：字段名称Save()保存页面信息并返回错误信息。返回：string 返回错误信息如果正确则返回空串。ClearData()清空控件赋值返回：string 返回错误信息如果正确则返回空串。Search()搜索返回：查询SQL 前面有andSearchRestore(Hashtable hTable)搜索还原参数：保存有页面状态的HashtableSearchBackup(Hashtable hTable)搜索备份参数：保存有页面状态的HashtableSearchClear()搜索清空2.7. 涉及的库表表名：SM_BuiltCollect序号列名数据类型长度小数位标识主键允许空默认值说明1TableNamevarchar500是否表名2Descriptionvarchar1000否表描述表名：SM_BuiltItem序号列名数据类型长度小数位标识主键允许空默认值说明1TableNamevarchar500否表名2FieldNamevarchar500否字段名3ViewNamevarchar1000是多视图录入。用于对一个表进行多种录入方式。4Descriptionvarchar1000否字段描述5FieldTypevarchar500否字段类型6FieldLensmallint20是字段长度7FieldDecsmallint20是字段精度8CodeIdvarchar20是CodeId9OnlyLeafbit10否只能选择叶子节点 仅类型为Code是有用10Flagbit10否1是否可见11ReadOnlybit10否0是否只读12NotNullbit10否1是否允许为空13DefaultValuevarchar500是14OrderIdsmallint20否排序15IsRowbit10否0是否独占一行16SkinIDvarchar500是控件SkinID17Widthvarchar500是控件宽度18Heightvarchar500是控件高度19ToolTipvarchar80000是控件的ToolTip20FieldShortestLensmallint20是表名：SM_CodeCollect参数类型表序号列名数据类型长度小数位标识主键允许空默认值说明1CodeIdchar20是否参数类型ID2Descriptionvarchar1000否描述表名：SM_CodeItem参数明细表序号列名数据类型长度小数位标识主键允许空默认值说明1CodeIdchar20是否参数ID2Codevarchar500是否参数3Descriptionvarchar1000是描述4Pptrvarchar500是父级CodeId5Cptrbit10是0是否含有子集6Flagbit10是1是否可用7ShortNamevarchar1000是简称8OrderIdint40是排序9Scoreint40是表名：SM_ListCollect序号列名数据类型长度小数位标识主键允许空默认值说明1ListNamevarchar1000是否2Descriptionvarchar2000是表名：SM_ListItem序号列名数据类型长度小数位标识主键允许空默认值说明1ListNamevarchar1000否2FieldTypevarchar500是3HeaderTextvarchar2000是4DataFieldvarchar2000是5DataFormatStringvarchar1000是6SortExpressionvarchar2000是7Visiblevarchar500是8InsertIndexint40是9Widthvarchar500是10HorizontalAlignvarchar500是11DataNavigateUrlFieldsvarchar1000是12DataNavigateUrlFormatStringvarchar5000是13Targetvarchar500是14IfTotalvarchar500是表名：SM_SearchCollect序号列名数据类型长度小数位标识主键允许空默认值说明1SearchPageNamevarchar1000是否2Descriptionvarchar1000是表名：SM_SearchItem序号列名数据类型长度小数位标识主键允许空默认值说明1SearchPageNamevarchar1000否2FieldNamevarchar500否3Descriptionvarchar1000是4FieldTypevarchar500是5CodeIdvarchar500是6OrderIdint40是7SkinIDvarchar500是8Widthvarchar500是9ToolTipvarchar2000是10PrefixHtmlvarchar2000是11SuffixHtmlvarchar2000是12SearchSqlvarchar2000是13Visiblevarchar500是0114ViewNamevarchar1000是视图名称3. 使用说明增加页面：Aspx页面 无标题页 页面标题>>   CS页面protected void Page_Load(object sender, EventArgs e) if (!IsPostBack) if (RequestId != null & RequestAction = View)/查看 WebViewInput1.ViewWhere = Id= + RequestId + ; WebViewInput1.View(); btnSave.Visible = false; btnReturn.Visible = false; else if (RequestId != null)/修改 WebViewInput1.ViewWhere = Id= + RequestId + ; WebViewInput1.Modify(); else WebViewInput1.Add(); protected void btnSave_Click(object sender, EventArgs e) string strError = WebViewInput1.Save(); if (strError = ) ScriptManager.RegisterStartupScript(this.Page, this.GetType(), 11, alert(保存成功。);location.href=Page_List.aspx?Id=?PageReturn=true;, true);/修改 else ScriptManager.RegisterStartupScript(this.Page, this.GetType(), 11, alert(保存失败， + strError + );, true); protected void btnReturn_Click(object sender, EventArgs e) Response.Redirect(Page_List.aspx?PageReturn=true); 列表页面Aspx页面 无标题页 每页记录： 10条 20条 50条 500条 不分页 序号 CS页面#region Page_Load protected void Page_Load(object sender, EventArgs e) if (!IsPostBack) if (SessionPageStatus != null & RequestPageReturn != null)/设置页面状态 RestorePageStatus(); else if (SessionPageStatus != null) Session.Remove(PageStatus); ViewStatestrFilter = ;/查询条件 ViewStateOrderField = BaseTable.Id;/用于排序的字段 ViewStateOrderWay = ASC;/用于排序的方向 DESC if (RequestAction = View)/查看 btnAdd.Visible = false; MyGridView1.ColumnsMyGridView1.Columns.Count - 1.Visible = false;/删除 MyGridView1.ColumnsMyGridView1.Columns.Count - 2.Visible = false;/修改 BindGridView(); #endregion #region 私有方法 #region 还原页面状态 / / 还原页面状态 还原查询信息、分页信息、查询条件、排序信息、滚动条信息 / private void RestorePageStatus() /还原页面状态 还原查询信息、分页信息、查询条件、排序信息、滚动条信息 Hashtable hTable = (Hashtable)SessionPageStatus; /查询信息 WebViewInput1.SearchRestore(hTable); /分页信息 MyGridView1.PageIndex = Convert.ToInt32(hTablePageIndex); ddlPageSize.SelectedValue = hTablePageSize.ToString(); /查询条件 ViewStatestrFilter = hTablestrFilter; /排序信息 ViewStateOrderField = hTableOrderField;/用于排序的字段 ViewStateOrderWay = hTableOrderWay;/用于排序的方向 /固定滚动条 ScriptManager.RegisterStartupScript(this.Page, this.GetType(), 11, document.all(divList_scrollLeft).value= + hTabledivList_scrollLeft + ;document.all(divList_scrollTop).value= + hTabledivList_scrollTop + ;document.all(divList).scrollLeft=document.all(divList_scrollLeft).value;document.all(divList).scrollTop=document.all(divList_scrollTop).value;, true); /删除保存页面状态Session /Session.Remove(PageStatus);/不用删除 如果删除，返回页面后刷新页面，页面状态消失 #endregion #region 备份页面状态 / / 备份页面状态 保存查询信息、分页信息、查询条件、排序信息、滚动条信息 / private void BackupPageStatus() /备份页面状态 保存查询信息、分页信息、查询条件、排序信息、滚动条信息 Hashtable hTable = new Hashtable(); /查询信息 WebViewInput1.SearchBackup(hTable); /分页信息 hTable.Add(PageIndex, MyGridView1.PageIndex); hTable.Add(PageSize, MyGridView1.PageSize); /查询条件 hTable.Add(strFilter, ViewStatestrFilter); /排序信息 hTable.Add(OrderField, ViewStateOrderField);/用于排序的字段 hTable.Add(OrderWay, ViewStateOrderWay);/用于排序的方向 /滚动条信息 hTable.Add(divList_scrollTop, RequestdivList_scrollTop);/ hTable.Add(divList_scrollLeft, RequestdivList_scrollLeft); /将页面状态保存到Session SessionPageStatus = hTable; #endregion #region 绑定列表 private void BindGridView() DAL_BaseInfo dal = new DAL_BaseInfo(); DataTable dt = dal.GetList(1=1 + ViewStatestrFilter + order by + ViewStateOrderField + + ViewStateOrderWay); if (ddlPageSize.SelectedValue != ) MyGridView1.PageSize = Convert.ToInt32(ddlPageSize.SelectedValue); else MyGridView1.AllowPaging = false; MyGridView1.DataSource = dt.DefaultView; MyGridView1.DataBind(); #endregion #endregion #region GridView事件 protected void MyGridView1_PageIndexChanging(object sender, GridViewPageEventArgs e) MyGridView1.PageIndex = e.NewPageIndex; BindGridView(); protected void MyGridView1_RowDeleting(object sender, GridViewDeleteEventArgs e) DAL_BaseInfo dal = new DAL_BaseInfo(); int iResult = dal.Delete(MyGridView1.DataKeyse.RowIndex.ValuesId.ToString(); if (iResult 0) ScriptManager.RegisterStartupScript(this.Page, this.GetType(), 11, alert(删除成功。);, true); else ScriptManager.RegisterStartupScript(this.Page, this.GetType(), 11, alert(删除失败。);, true); BindGridView(); protected void MyGridView1_RowUpdating(object sender, GridViewUpdateEventArgs e) BackupPageStatus(); Response.Redirect(Page_Add.aspx? Id= + MyGridView1.DataKeyse.RowIndex.ValuesId.ToString() + &Action=Mod&strURL=Page_List.aspx?PageRet