using System;
using System.Collections.Generic;
using System.Web.UI;
using System.Web.UI.WebControls;
using NewLife.Reflection;
using NewLife.Web;
using XCode;
using XCode.Configuration;
namespace NewLife.CommonEntity.Web
{
/// <summary>实体表单基类</summary>
/// <typeparam name="TKey">主键类型</typeparam>
/// <typeparam name="TEntity">表单实体类</typeparam>
/// <typeparam name="TAdminEntity">管理员类</typeparam>
/// <typeparam name="TMenuEntity">菜单类</typeparam>
[Obsolete("不再需要指定管理员类和菜单类，请改用EntityForm<TKey, TEntity>类替代！")]
public class EntityForm<TKey, TEntity, TAdminEntity, TMenuEntity> : EntityForm<TKey, TEntity>
where TEntity : Entity<TEntity>, new()
where TAdminEntity : Administrator<TAdminEntity>, new()
where TMenuEntity : Menu<TMenuEntity>, new()
{
}
/// <summary>实体表单基类</summary>
/// <typeparam name="TKey">主键类型</typeparam>
/// <typeparam name="TEntity">表单实体类</typeparam>
public class EntityForm<TKey, TEntity> : WebPageBase
where TEntity : Entity<TEntity>, new()
{
#region 基本属性
/// <summary>主键名称，字符串默认返回Guid，其它默认返回ID</summary>
protected virtual String EntityKeyName
{
get
{
if (Entity<TEntity>.Meta.Unique != null) return Entity<TEntity>.Meta.Unique.Name;
Type type = typeof(TKey);
if (type == typeof(Int32))
return "ID";
else if (type == typeof(String))
return "Guid";
else
return "ID";
}
}
/// <summary>主键</summary>
public TKey EntityID
{
get
{
String str = Request[EntityKeyName];
if (String.IsNullOrEmpty(str)) return default(TKey);
Type type = typeof(TKey);
if (type == typeof(Int32))
{
Int32 id = 0;
if (!Int32.TryParse(str, out id)) id = 0;
return (TKey)(Object)id;
}
else if (type == typeof(String))
{
return (TKey)(Object)str;
}
else
throw new NotSupportedException("仅支持整数和字符串类型！");
}
}
private TEntity _Entity;
/// <summary>数据实体</summary>
public virtual TEntity Entity
{
get { return _Entity ?? (_Entity = GetEntity()); }
set { _Entity = value; }
}
/// <summary>获取数据实体，允许页面重载改变实体</summary>
protected virtual TEntity GetEntity()
{
return Entity<TEntity>.FindByKeyForEdit(EntityID);
}
/// <summary>表单项名字前缀，默认frm</summary>
protected virtual String FormItemPrefix { get { return "frm"; } }
#endregion
#region 扩展属性
/// <summary>保存按钮，查找名为btnSave或UpdateButton（兼容旧版本）的按钮，如果没找到，将使用第一个使用了提交行为的按钮</summary>
protected virtual Control SaveButton
{
get
{
Control control = FindControl("btnSave");
if (control != null) return control;
control = FindControl("UpdateButton");
if (control != null) return control;
// 随便找一个按钮
Button btn = ControlHelper.FindControl<Button>(Page, null);
if (btn != null && btn.UseSubmitBehavior) return btn;
return null;
}
}
/// <summary>是否空主键</summary>
protected virtual Boolean IsNullKey
{
get
{
Type type = typeof(TKey);
if (type == typeof(Int32))
{
return (Int32)(Object)EntityID <= 0;
}
else if (type == typeof(String))
{
return String.IsNullOrEmpty((String)(Object)EntityID);
}
else
throw new NotSupportedException("仅支持整数和字符串类型！");
}
}
#endregion
#region 事件
/// <summary>已重载。设置控件必填项</summary>
/// <param name="e"></param>
protected override void OnInitComplete(EventArgs e)
{
base.OnInitComplete(e);
foreach (FieldItem field in Entity<TEntity>.Meta.AllFields)
{
Control control = FindControlByField(field);
if (control == null) continue;
// 必填项
if (!field.IsNullable) SetNotAllowNull(field, control, true);
}
}
/// <summary>已重载。</summary>
/// <param name="e"></param>
protected override void OnPreLoad(EventArgs e)
{
base.OnPreLoad(e);
// 判断实体
if (Entity == null)
{
String msg = null;
if (IsNullKey)
msg = String.Format("参数错误！无法取得编号为{0}的{1}！可能未设置自增主键！", EntityID, Entity<TEntity>.Meta.TableName);
else
msg = String.Format("参数错误！无法取得编号为{0}的{1}！", EntityID, Entity<TEntity>.Meta.TableName);
WebHelper.Alert(msg);
Response.Write(msg);
Response.End();
return;
}
Control btn = SaveButton;
if (!Page.IsPostBack)
{
if (btn != null)
{
// 添加/编辑 按钮需要添加/编辑权限
//if (IsNullKey)
// btn.Visible = Acquire(PermissionFlags.Insert);
//else
// btn.Visible = Acquire(PermissionFlags.Update);
btn.Visible = CanSave;
if (btn is IButtonControl) (btn as IButtonControl).Text = IsNullKey ? "新增" : "更新";
}
SetForm();
}
else
{
if (btn != null && btn is IButtonControl)
(btn as IButtonControl).Click += delegate { GetForm(); if (ValidForm()) SaveFormWithTrans(); };
// 这里还不能保存表单，因为使用者习惯性在Load事件里面写业务代码，所以只能在Load完成后保存
//else if (Page.AutoPostBackControl == null)
//{
// GetForm();
// if (ValidForm()) SaveFormWithTrans();
//}
}
}
/// <summary>已重载。当没有按钮时保存表单</summary>
/// <param name="e"></param>
protected override void OnLoadComplete(EventArgs e)
{
base.OnLoadComplete(e);
if (Page.IsPostBack && Page.AutoPostBackControl == null)
{
Control btn = SaveButton;
if (btn == null || !(btn is IButtonControl))
{
GetForm();
if (ValidForm()) SaveFormWithTrans();
}
}
}
/// <summary>查找表单控件</summary>
/// <param name="id"></param>
/// <returns></returns>
public override Control FindControl(string id)
{
Control control = ControlHelper.FindControlInPage<Control>(id);
if (control != null) return control;
control = base.FindControl(id);
if (control != null) return control;
return ControlHelper.FindControl<Control>(Page.Form, id);
}
/// <summary>查找字段对应的控件</summary>
/// <param name="field"></param>
/// <returns></returns>
protected virtual Control FindControlByField(FieldItem field)
{
return FindControl(FormItemPrefix + field.Name);
}
#endregion
#region 加载
/// <summary>把实体的属性设置到控件上</summary>
protected virtual void SetForm()
{
// 是否有权限保存数据
Boolean canSave = CanSave;
foreach (FieldItem item in Entity<TEntity>.Meta.AllFields)
{
Control control = FindControlByField(item);
if (control == null) continue;
try
{
SetFormItem(item, control, canSave);
}
catch (Exception ex)
{
WebHelper.Alert("设置" + item.Name + "的数据时出错！" + ex.Message);
return;
}
}
}
/// <summary>是否有权限保存数据</summary>
protected virtual Boolean CanSave
{
get
{
return IsNullKey && Acquire(PermissionFlags.Insert) || Acquire(PermissionFlags.Update);
}
}
/// <summary>把实体成员的值设置到控件上</summary>
/// <param name="field"></param>
/// <param name="control"></param>
/// <param name="canSave"></param>
protected virtual void SetFormItem(FieldItem field, Control control, Boolean canSave)
{
if (field == null || control == null) return;
String toolTip = String.IsNullOrEmpty(field.Description) ? field.Name : field.Description;
if (field.IsNullable)
toolTip = String.Format("请填写{0}！", toolTip);
else
toolTip = String.Format("必须填写{0}！", toolTip);
if (control is Label) toolTip = null;
if (control is WebControl)
{
WebControl wc = control as WebControl;
// 设置ToolTip
if (String.IsNullOrEmpty(wc.ToolTip) && !String.IsNullOrEmpty(toolTip)) wc.ToolTip = toolTip;
//// 必填项
//if (!field.IsNullable) SetNotAllowNull(field, control, canSave);
// 设置只读，只有不能保存时才设置，因为一般都不是只读，而前端可能自己设置了控件为只读，这种情况下这里再设置就会修改前端的意思
if (!canSave)
{
if (wc is TextBox)
(wc as TextBox).ReadOnly = !canSave;
else
wc.Enabled = canSave;
}
// 分控件处理
if (wc is TextBox)
SetFormItemTextBox(field, wc as TextBox, canSave);
else if (wc is Label)
SetFormItemLabel(field, wc as Label, canSave);
else if (wc is RadioButton)
SetFormItemRadioButton(field, wc as RadioButton, canSave);
else if (wc is CheckBox)
SetFormItemCheckBox(field, wc as CheckBox, canSave);
else if (wc is ListControl)
SetFormItemListControl(field, wc as ListControl, canSave);
else
{
SetControlValue(control, Entity[field.Name]);
}
}
else
{
SetControlValue(control, Entity[field.Name]);
PropertyInfoX pix = PropertyInfoX.Create(control.GetType(), "ToolTip");
if (pix != null && String.IsNullOrEmpty((String)pix.GetValue(control)))
{
pix.SetValue(control, toolTip);
}
}
}
/// <summary>文本框</summary>
/// <param name="field"></param>
/// <param name="control"></param>
/// <param name="canSave"></param>
protected virtual void SetFormItemTextBox(FieldItem field, TextBox control, Boolean canSave)
{
Type type = field.Type;
Object value = Entity[field.Name];
if (type == typeof(DateTime))
{
DateTime d = (DateTime)value;
if (IsNullKey && d == DateTime.MinValue) d = DateTime.Now;
//control.Text = d.ToString("yyyy-MM-dd HH:mm:ss");
//else
// control.Text = null;
value = d.ToString("yyyy-MM-dd HH:mm:ss");
}
//else
// control.Text = String.Empty + Entity[field.Name];
if (!SetControlValue(control, value)) control.Text = value.ToString();
}
/// <summary>标签</summary>
/// <param name="field"></param>
/// <param name="control"></param>
/// <param name="canSave"></param>
protected virtual void SetFormItemLabel(FieldItem field, Label control, Boolean canSave)
{
Type type = field.Type;
if (type == typeof(DateTime))
{
DateTime d = (DateTime)Entity[field.Name];
if (IsNullKey && d == DateTime.MinValue) d = DateTime.Now;
control.Text = d.ToString("yyyy-MM-dd HH:mm:ss");
}
else if (type == typeof(Decimal))
{
Decimal d = (Decimal)Entity[field.Name];
control.Text = d.ToString("c");
}
else
control.Text = String.Empty + Entity[field.Name];
}
/// <summary>复选框</summary>
/// <param name="field"></param>
/// <param name="control"></param>
/// <param name="canSave"></param>
protected virtual void SetFormItemCheckBox(FieldItem field, CheckBox control, Boolean canSave)
{
Type type = field.Type;
if (type == typeof(Boolean))
control.Checked = (Boolean)Entity[field.Name];
else if (type == typeof(Int32))
control.Checked = (Int32)Entity[field.Name] != 0;
else
control.Checked = Entity[field.Name] != null;
}
/// <summary>列表框</summary>
/// <param name="field"></param>
/// <param name="control"></param>
/// <param name="canSave"></param>
protected virtual void SetFormItemListControl(FieldItem field, ListControl control, Boolean canSave)
{
if (control.Items.Count < 1) control.DataBind();
if (control.Items.Count < 1) return;
String value = String.Empty + Entity[field.Name];
ListItem li = control.Items.FindByValue(value);
if (li != null)
li.Selected = true;
else
{
li = new ListItem(value, value);
control.Items.Add(li);
li.Selected = true;
}
}
/// <summary>单选框</summary>
/// <param name="field"></param>
/// <param name="control"></param>
/// <param name="canSave"></param>
protected virtual void SetFormItemRadioButton(FieldItem field, RadioButton control, Boolean canSave)
{
List<RadioButton> list = new List<RadioButton>();
// 找到同一级同组名的所有单选
foreach (Control item in control.Parent.Controls)
{
if (!(item is RadioButton)) continue;
RadioButton rb = item as RadioButton;
if (rb.GroupName != control.GroupName) continue;
list.Add(rb);
}
if (list.Count < 1) return;
// 特殊处理数字
if (field.Type == typeof(Int32))
{
Int32 id = (Int32)Entity[field.Name];
if (id < 0 || id >= list.Count) id = 0;
for (int i = 0; i < list.Count; i++)
{
list[i].Checked = (i == id);
}
}
else
{
String value = String.Empty + Entity[field.Name];
foreach (RadioButton item in list)
{
item.Checked = item.Text == value;
}
}
}
/// <summary>设置控件的不允许空</summary>
/// <param name="field"></param>
/// <param name="control"></param>
/// <param name="canSave"></param>
protected virtual void SetNotAllowNull(FieldItem field, Control control, Boolean canSave)
{
if (field.IsNullable) return;
// Label后面不需要
if (control is Label) return;
LiteralControl lc = new LiteralControl();
lc.Text = "<font style='color:#FF0000;font-size:16pt;'> *</font>";
Int32 p = control.Parent.Controls.IndexOf(control);
// 有时候可能无法添加，但是不影响使用，应该屏蔽异常
try
{
control.Parent.Controls.AddAt(p + 1, lc);
}
catch { }
}
#endregion
#region 读取
/// <summary>读取控件的数据保存到实体中去</summary>
protected virtual void GetForm()
{
foreach (FieldItem item in Entity<TEntity>.Meta.AllFields)
{
Control control = FindControlByField(item);
if (control == null) continue;
try
{
GetFormItem(item, control);
}
catch (Exception ex)
{
WebHelper.Alert("读取" + item.Name + "的数据时出错！" + ex.Message);
return;
}
}
}
/// <summary>把控件的值设置到实体属性上</summary>
/// <param name="field"></param>
/// <param name="control"></param>
protected virtual void GetFormItem(FieldItem field, Control control)
{
if (field == null || control == null) return;
if (control is WebControl)
{
WebControl wc = control as WebControl;
// 分控件处理
if (wc is TextBox)
GetFormItemTextBox(field, wc as TextBox);
else if (wc is Label)
GetFormItemLabel(field, wc as Label);
else if (wc is RadioButton)
GetFormItemRadioButton(field, wc as RadioButton);
else if (wc is CheckBox)
GetFormItemCheckBox(field, wc as CheckBox);
else if (wc is ListControl)
GetFormItemListControl(field, wc as ListControl);
else
{
Object v = null;
if (GetControlValue(control, out v) && !Object.Equals(Entity[field.Name], v)) SetEntityItem(field, v);
}
}
else
{
Object v = null;
if (GetControlValue(control, out v) && !Object.Equals(Entity[field.Name], v)) SetEntityItem(field, v);
}
}
void SetEntityItem(FieldItem field, Object value)
{
// 先转为目标类型
value = TypeX.ChangeType(value, field.Type);
// 如果是字符串，并且为空，则让它等于实体里面的值，避免影响脏数据
if (field.Type == typeof(String) && String.IsNullOrEmpty((String)value) && String.IsNullOrEmpty((String)Entity[field.Name])) value = Entity[field.Name];
Entity.SetItem(field.Name, value);
}
/// <summary>文本框</summary>
/// <param name="field"></param>
/// <param name="control"></param>
protected virtual void GetFormItemTextBox(FieldItem field, TextBox control)
{
//String v = control.Text;
//if (!Object.Equals(Entity[field.Name], v)) SetEntityItem(field, v);
Object v = null;
if (!GetControlValue(control, out v)) v = control.Text;
if (!Object.Equals(Entity[field.Name], v)) SetEntityItem(field, v);
}
/// <summary>标签，不做任何操作</summary>
/// <param name="field"></param>
/// <param name="control"></param>
protected virtual void GetFormItemLabel(FieldItem field, Label control)
{
}
/// <summary>复选框</summary>
/// <param name="field"></param>
/// <param name="control"></param>
protected virtual void GetFormItemCheckBox(FieldItem field, CheckBox control)
{
Type type = field.Type;
Object v;
if (type == typeof(Boolean))
v = control.Checked;
else if (type == typeof(Int32))
v = control.Checked ? 1 : 0;
else
v = control.Checked;
if (!Object.Equals(Entity[field.Name], v)) SetEntityItem(field, v);
}
/// <summary>列表框</summary>
/// <param name="field"></param>
/// <param name="control"></param>
protected virtual void GetFormItemListControl(FieldItem field, ListControl control)
{
//if (String.IsNullOrEmpty(control.SelectedValue)) return;
String v = control.SelectedValue;
if (!Object.Equals(Entity[field.Name], v)) SetEntityItem(field, v);
}
/// <summary>单选框</summary>
/// <param name="field"></param>
/// <param name="control"></param>
protected virtual void GetFormItemRadioButton(FieldItem field, RadioButton control)
{
List<RadioButton> list = new List<RadioButton>();
// 找到同一级同组名的所有单选
foreach (Control item in control.Parent.Controls)
{
if (!(item is RadioButton)) continue;
RadioButton rb = item as RadioButton;
if (rb.GroupName != control.GroupName) continue;
list.Add(rb);
}
if (list.Count < 1) return;
// 特殊处理数字
if (field.Type == typeof(Int32))
{
Int32 id = -1;
for (int i = 0; i < list.Count; i++)
{
if (list[i].Checked)
{
id = i;
break;
}
}
if (id >= 0 && !Object.Equals(Entity[field.Name], id)) SetEntityItem(field, id);
}
else
{
foreach (RadioButton item in list)
{
if (item.Checked)
{
if (!Object.Equals(Entity[field.Name], item.Text)) SetEntityItem(field, item.Text);
}
}
}
}
#endregion
#region 验证
/// <summary>验证表单，返回是否有效数据</summary>
/// <returns></returns>
protected virtual Boolean ValidForm()
{
//foreach (FieldItem item in Entity<TEntity>.Meta.AllFields)
foreach (FieldItem item in Entity<TEntity>.Meta.Fields)
{
Control control = FindControlByField(item);
if (control == null) continue;
if (!ValidFormItem(item, control)) return false;
}
return true;
}
/// <summary>验证表单项</summary>
/// <param name="field"></param>
/// <param name="control"></param>
/// <returns></returns>
protected virtual Boolean ValidFormItem(FieldItem field, Control control)
{
// 必填项
if (!field.IsNullable)
{
if (field.Type == typeof(String))
{
if (String.IsNullOrEmpty((String)Entity[field.Name]))
{
WebHelper.Alert(String.Format("{0}不能为空！", String.IsNullOrEmpty(field.Description) ? field.Name : field.Description));
control.Focus();
return false;
}
}
else if (field.Type == typeof(DateTime))
{
DateTime d = (DateTime)Entity[field.Name];
if (d == DateTime.MinValue || d == DateTime.MaxValue)
{
WebHelper.Alert(String.Format("{0}不能为空！", String.IsNullOrEmpty(field.Description) ? field.Name : field.Description));
control.Focus();
return false;
}
}
}
return true;
}
#endregion
#region 保存
private void SaveFormWithTrans()
{
Entity<TEntity>.Meta.BeginTrans();
try
{
SaveForm();
Entity<TEntity>.Meta.Commit();
SaveFormSuccess();
}
catch (Exception ex)
{
Entity<TEntity>.Meta.Rollback();
SaveFormUnsuccess(ex);
}
}
/// <summary>保存表单，把实体保存到数据库，当前方法处于事务保护之中</summary>
protected virtual void SaveForm()
{
Entity.Save();
}
/// <summary>保存成功</summary>
protected virtual void SaveFormSuccess()
{
// 这个地方需要考虑一个问题，就是列表页查询之后再打开某记录进行编辑，编辑成功后，如果强行的reload列表页，浏览器会循环是否重新提交
// 经测试，可以找到列表页的那个查询按钮，模拟点击一次它，实际上就是让ASP.Net列表页回发一次，可以解决这个问题
ClientScript.RegisterStartupScript(this.GetType(), "alert", @"alert('成功！');
(function(){
var load=window.onload;
window.onload=function(){
if(load) load();
parent.Dialog.CloseAndRefresh(frameElement);
};
})();
", true);
}
/// <summary>保存失败</summary>
/// <param name="ex"></param>
protected virtual void SaveFormUnsuccess(Exception ex)
{
// 如果是参数异常，参数名可能就是字段名，可以定位到具体控件
ArgumentException ae = ex as ArgumentException;
if (ae != null && !String.IsNullOrEmpty(ae.ParamName))
{
Control control = FindControl(FormItemPrefix + ae.ParamName);
if (control != null) control.Focus();
}
WebHelper.Alert("失败！" + ex.Message);
}
#endregion
#region 辅助
static Boolean GetControlValue(Control control, out Object value)
{
TypeX tx = control.GetType();
String name = tx.GetCustomAttributeValue<ControlValuePropertyAttribute, String>();
PropertyInfoX pix = null;
if (!String.IsNullOrEmpty(name)) pix = PropertyInfoX.Create(tx.Type, name);
if (pix == null) pix = PropertyInfoX.Create(tx.Type, "Value");
if (pix == null) pix = PropertyInfoX.Create(tx.Type, "Text");
if (pix != null)
{
value = pix.GetValue(control);
return true;
}
value = null;
return false;
}
static Boolean SetControlValue(Control control, Object value)
{
TypeX tx = control.GetType();
String name = tx.GetCustomAttributeValue<ControlValuePropertyAttribute, String>();
PropertyInfoX pix = null;
if (!String.IsNullOrEmpty(name)) pix = PropertyInfoX.Create(tx.Type, name);
if (pix == null) pix = PropertyInfoX.Create(tx.Type, "Value");
if (pix == null) pix = PropertyInfoX.Create(tx.Type, "Text");
if (pix != null)
{
pix.SetValue(control, value);
return true;
}
return false;
}
#endregion
}
}
|