Steven Blogs

创建具有自验证功能的textbox控件

kwklover（翻译）
关键字  textbox,控件开发,验证
出处   http://www.codeproject.com/aspnet/selfvalidatingtextbox.asp?target=Self%7CValidating%7CASP...

导言

在强大的.NET面前，我有很多的想法，我希望asp.net的web控件内建有验证功能，而不需要在页面中插入太多的验证控件以致代码混乱！现在我们将可以利用.NET来创建一个只允许输入整型数字的的textbox控件或只允许输入货币型数据的textbox控件，等等。当然了，你还可以特别指定textbox控件可否为空或者是否在一个范围内，等等，另外，当我们输入的数据符合要求时，还可以返回一个值，以方便我们觉得是否要干预，甚至我们可以让它运行的时候根据输入数据是否符合要求呈现不同的颜色

经过一番努力，我终于实现以上的想法

实现IValidator接口

我在钻研SDK文档时发现，只要实现了IValidator接口，任何的控件都可以具有验证功能，以下是一个继承textbox控件的简单的例子：

using System;
using System.Web.UI.WebControls;
using System.Web.UI;

namespace MyValidatingControls {
   public class TextBox : System.Web.UI.WebControls.TextBox, IValidator {
      private bool _valid = true;
      private string _errorMessage = "";

      public bool IsValid {
         get { return _valid; }
         set { _valid = value; }
      }

      public string ErrorMessage {
         get { return _errorMessage; }
         set { _errorMessage = value; }
      }

      public void Validate() {
      }
   }
}

当然了，这段程序什么都不做，但是它完全实现了基本的IValidator接口的架构（至少它是可以成功编译的），我使用Private关键字创建两个字段（field）用来保存验证状态和错误信息，为了确保验证控件能被执行，我们必须把我们的验证控件添加到页面中的验证控件集合中来。

我在阅读SDK文档的时候发现，验证控件是在初始化期间加载他们本身的，IValidators接口主要用来注册他们自己，所以我们需要使用覆盖的方法重新实现OnInit和OnUnload事件，以便我们能从页面中的验证控件集合中添加或者删除它们

protected override void OnInit(EventArgs e) {
   base.OnInit(e);
   Page.Validators.Add(this);
}

protected override void OnUnload(EventArgs e) {
   if (Page != null) {
      Page.Validators.Remove(this);
   }
   base.OnUnload(e);
}

完成设置

在我们实现我们的验证功能之前，为了使事件更简洁，我设置了一些帮助项目，因为我不想单独分别单独提供验证控件的错误信息，而是希望把他们嵌入到控件中来，以实现我们所期望格式的数据录入，因此，我需要做一些事情，使它可以适当的出现错误提示。

我将添加一个叫做FriendlyName属性，它将在所有的错误提示信息中出现以提示用户合法的数据类型，所以，如果我们调用的控件ID是RetailPrice，我们将使该控件的riendlyName为Retail Price

private string _friendlyName = "";

public string FriendlyName {
   get { return _friendlyName; }
   set { _friendlyName = value; }
}

最后，我们重写IsValid事件，使它可以在验证不通过时可以改变控件的背景颜色

public bool IsValid {
   get { return _valid; }
   set {
      _valid = value;
      if (!_valid) {
         this.BackColor = Color.LightCoral;
      }
      else {
         this.BackColor = Color.White;
      }
   }
}

不允许出现空格

首先我们需要确定，提供一个可选项以决定是否允许为空值，我们在这里需要创建一个属性以判断是否可以为空

private bool _blankAllowed = true;

public bool AllowBlank {
    get { return _blankAllowed; }
    set { _blankAllowed = value; }
}

最后，我们可以重写验证函数

public virtual void Validate() {
   this.IsValid = true;

   if (!this.AllowBlank) {
      bool isBlank = (this.Text.Trim() == "");

      if (isBlank) {
         this.ErrorMessage = String.Format("'{0}' cannot be blank.", this.FriendlyName);
         this.IsValid = false;
      }
   }
}

拓展我们的创意

现在我们已经创建了一个内建基本验证功能的textbox控件，现在我们可以延展我们的想法，创建更多的有趣的具有特定验证功能的textbox控件

下面以创建一个只允许输入整型数据的textbox控件（IntegerTextBox），并且使该控件具有只允许输入的数据必须在一定的范围内，但我们仍然需要考虑是否允许空值，所以，象上面一样，需要添加一个属性

在上面我们创建的基本的textbox控件的基础上，我们仅仅需要继承该控件，然后覆盖Validate函数和添加一些新的属性

private int _minValue = Int32.MinValue;
private int _maxValue = Int32.MaxValue;

public int MinValue {
   get { return _minValue; }
   set {
      _minValue = value;
      
      if (_minValue > _maxValue) {
          int swap = _minValue;
          _minValue = _maxValue;
          _maxValue = swap;
      }
   }
}

public int MaxValue {
   get { return _maxValue; }
   set {
      _maxValue = value;
      
      if (_minValue > _maxValue) {
          int swap = _minValue;
          _minValue = _maxValue;
          _maxValue = swap;
      }
   }
}

然后，我们扩充该Validate函数，并把编译它为本地代码

public override void Validate() {
   this.IsValid = true;

   bool isBlank = (this.Text.Trim() == "");

   if (isBlank) {
      if (!AllowBlank) {
         this.ErrorMessage = String.Format("'{0}' " + "cannot be blank.", this.FriendlyName);
         this.IsValid = false;
      }
   } else {
      try {
         _value = Int32.Parse(this.Text);
         if (_value < this.MinValue) {
            this.ErrorMessage = String.Format("'{0}' cannot " + "be less than {1}", this.FriendlyName, this.MinValue);
            this.IsValid = false;
         }

         if (_value > this.MaxValue) {
            this.ErrorMessage = String.Format("'{0}' " + "cannot be more than {1}",  this.FriendlyName, this.MinValue);
            this.IsValid = false;
         }
      } catch {
         this.ErrorMessage = String.Format("'{0}' " + "is not a valid integer.", this.FriendlyName);
         this.IsValid = false;
      }
   }
}

public int Value {
   get { return _value; }
   set { 
      _value = value;
      this.Text = _value.ToString();
   }
}

结论

要写就那么多了，现在我们还可以在这个类的基础上创建诸如要求只能输入符合一定时间格式和货币格式，下面我们举一个例子以说明如何使用我们创建的控件

在此以前我们要实现同样的功能需要写以下的代码：

<asp:TextBox id="Number" runat="server"/>
<asp:RequiredFieldValidator id="RequiredFieldValidator2"
   ControlToValidate="Number" 
   Text="'Number' cannot be blank." runat="server"/>
<asp:RangeValidator id="Range1" ControlToValidate="Number"
   MinimumValue="0" MaximumValue="100"
   Type="Integer" Text="The value must be from 0 to 100!"
   runat="server"/>

而现在，我们仅仅需一句：

MyControls:IntegerText id="Number"
    FriendlyName="Number" MinValue="0" MaxValue="100"
    AllowBlank="false" runat="server">

最后，需要说明的是，我创建的这个类相对与现有的验证来说并不那么完美，一个明显需要改进地方是，我们需要在该类中添加客户端脚本，以使验证行为可以不只在服务器端触发，也可以在客户端触发

我希望每一个人都能理解它的运行原理，以便你有更好的创意的时候可以修正它，也许有一天我可能会使用你创建的具有完美功能的类集。

Download source and demo filesopen in new window

译注：由于本人的翻译水平有限和时间关系，翻译的不是那么通顺，请见量，如果有什么问题，欢迎给我来信，我们一起探讨
hisuifeng@etang.com

Contributors: FHL