NumericalBox - WPF TextBox 的子类，只接受格式正确的十进制数

• 下载源代码 - 24.2 KB
• 下载演示 - 9.7 KB

引言

存在大量允许只输入数字的 TextBox 的子类实现。通常，畸形数字的拒绝是在额外的验证阶段提供的，并且在输入阶段允许诸如 1+234 或 .+1e23.4 之类的怪异输入。我们将设置输入约束，以便只能输入格式正确的数字。

正则表达式方法

我们希望在输入时只允许 [[-+]整数部分][.小数部分][{eE}[-+]指数] 格式的数字。

也就是说，诸如 123、+123、123.45、12e+45 等数字允许输入，而 123.、12.34.5、1+2345e 等数字则被禁止。同时，我们不会关心数字转换为机器格式（例如，按值）的能力。我们只检查数字的语法格式。

1950 年代伟大的 Stephen Kleene 发明的经典正则表达式为我们铺平了通往目标之路。我们将使用 C# 方言的正则表达式。

我们将实现一个NumericalBox - System.Windows.Controls.TextBox 类的简易子类。实现仅包含 3 个方法重写和一个辅助方法。让我们逐步考虑这些重写。

OnKey 重写

OnKey 是一个方法，它只允许允许的按键通过。通过设置不允许按键的 KeyEventArgs.Handled=true，我们隐藏了事件路由中OnKey 事件对监听器的可见性。允许的按键将调用监听器。

protected override void OnKeyDown(KeyEventArgs e)
{
    switch ( e.Key )
    {
        case Key.E:
        case Key.OemPlus:
        case Key.OemMinus:
        case Key.OemPeriod:
        case Key.Subtract:
        case Key.Add:
        case Key.Decimal:
        case Key.D0:
        case Key.D1:
        case Key.D2:
        case Key.D3:
        case Key.D4:
        case Key.D5:
        case Key.D6:
        case Key.D7:
        case Key.D8:
        case Key.D9:
        case Key.NumPad0:
        case Key.NumPad1:
        case Key.NumPad2:
        case Key.NumPad3:
        case Key.NumPad4:
        case Key.NumPad5:
        case Key.NumPad6:
        case Key.NumPad7:
        case Key.NumPad8:
        case Key.NumPad9:
        case Key.Back:
            break;
        default:
            e.Handled = true;
            break;
    }
}

OnKey 将阻止无意义的按键，但不会阻止畸形的数字，例如 +..1e.e.1 等。

数字验证的正则表达式

在文本更改时（即在输入时）检查数字的语法似乎是个好主意。现在，第一个正则表达式出现了。它是

[-+]?\d*(\.?)(\d+)([eE][-+]?\d+)?

含义：
[-+]? - 可选符号部分：匹配 -、+ 或无
\d* - 整数部分：匹配零个或多个十进制数字
(\.?) - 小数点部分：匹配零个或一个小数点的组
 (\d+)- 小数部分：匹配一个或多个十进制数字的组
 ([eE][-+]?\d+)?- 指数部分：匹配零个或一个指数基数（e 或 E）后跟可选符号，再后跟一个或多个十进制数字的组。

该正则表达式以 Regex 类型的变量形式提供；参数值 RegexOptions.ECMAScript 仅将可能的数字表示形式限制为英语。

Regex _rgxChangedValid = new Regex( @"^[-+]?\d*(\.?)(\d+)([eE][-+]?\d+)?$" );

锚点 ^ 和 $ 表示匹配从字符串的开头开始，并且必须发生在字符串的末尾。

OnTextChanged 重写 - 第一次尝试 - 项目 NumericalBoxCtrlJobHalfDone

让我们在OnTextChanged中实现以上所有内容

protected override void OnTextChanged( TextChangedEventArgs e )
{
    base.OnTextChanged( e );

    if ( !IsInputTextValid( Text ) )
    {
        Text = _lastVerifiedText;
    }

    _lastVerifiedText = Text;
    CaretIndex = Text.Length;
}

private bool IsInputTextValid( string text )
{
    return !string.IsNullOrEmpty( text == null ? null : text.Trim( ) ) 
        ? ( _rgxChangedValid.IsMatch( text ) ? true : false ) 
            : false;
}

私有变量 _lastVerifiedText 存储最后一个通过正则表达式检查的已键入字符串，并用于恢复上一个有效版本。最终项目NumericalTextBox将展示更方便的恢复方式。

现在让我们尝试项目NumericalTextBoxCtrlJobHalfDone - 启动演示NumericalTextBoxCtrlJobHalfDone.exe 并开始在文本框中输入数字 123.45。

尝试失败！我们无法输入小数点。

失败原因

问题在于我们的 _rgxChangedValid 描述了一个完整的、格式正确的数字；例如，它必须在小数点后至少包含一个数字。但是，在顺序输入过程中，用户无法同时输入小数点和它后面的第一个数字 - 小数点总是先出现并被拒绝。

Regex _rgxChangedValid = new Regex( @"^[-+]?\d*(\.?)(\d*)([eE][-+]?\d*)?$", RegexOptions.ECMAScript );

protected override void OnTextChanged( TextChangedEventArgs e )
{
    base.OnTextChanged( e );
    string longestValidText;

    if ( !IsTextValid( _rgxChangedValid, _rgxSaveChanged, Text, out longestValidText ) )
    {
        this.Text = longestValidText;
    }

    CaretIndex = Text.Length;
}

Regex _rgxLostFocusValid = new Regex( @"^[-+]?\d*(\.?)(\d+)([eE][-+]?\d+)?$", RegexOptions.ECMAScript );

protected override void OnLostFocus( RoutedEventArgs e )
{
    base.OnLostFocus( e );
    string longestValidText;

    if(!IsTextValid( _rgxLostFocusValid, _rgxSaveLost, Text, out longestValidText ))
    {
        this.Text = longestValidText;
    }
}

Regex _rgxSaveChanged = new Regex( @"[-+]?\d*(\.?)(\d*)([eE][-+]?\d*)?", RegexOptions.ECMAScript );

Regex _rgxSaveLost = new Regex( @"[-+]?\d*(\.?)(\d+)([eE][-+]?\d+)?", RegexOptions.ECMAScript );

longestValidSubstr = rgxSave.Match( text ).Value;

return !string.IsNullOrEmpty( text == null ? null : text.Trim( ) ) ? 
            rgxValid.IsMatch( text ) : 
                false;