VB.NET Maskedbox Control - Final Release

Sample Image - MaskedBox_Control.jpg

Introduction

VB.NET does not have a masked texbox and it's very important for user input. So I have made it myself because the components I have found is not good enough for me.

Details

The "#" character in the mask is used for digit only
The "&" character accepts letter or digit
Supported mask symbols are "-", ".", ",", "/", "\", ":"

Using Component

The use of this component is very simple. You have to select the toolbox panel, right click in the windows forms section and select customize toolbox.

Select .NET framework components, then click browse and select maskedbox.dll in the download path. The maskedbox component will appear at the end of windows forms panel. Now select the component and drop it on a form.

Then set the mask property with any combination of valid characters

Ex. ##.###.####-###.###/###

History

Initial - I fixed a bug where the space key is not recognized. This version inherits a textbox component to publish all features of the textbox plus maskedbox
20-jan-2003 Fixes - Function keys now are not handled by control. They cause an invalid character in between the text. The function SetText has been created. Programatically changing the text value in control din't change the masked text, so I created this function where the parameter is a string to fill the text (with no mask). If the text is "", then the text and mask is cleared with a empty mask.
21-jan-2003 - The Final Release!!! I hope! Accept all characters and function keys. The delete key is working now !

Comments

Any comments ? Email me at pdvtech@terra.com.br. Visit my business site at www.pdvtech.com.br.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

RicardoPDV

Web Developer

Brazil

Member

Im a 33 years old and work developing applications since 14 years old

COBOL, my first language (i love)
BASIC, i born know

Visual Basic Rock's

Article Top

Poor

Excellent

Add a reason or comment to your vote: x
Votes of 3 or less require a comment

Comments and Discussions

You must Sign In to use this message board. (secure sign-in)

Search this forum
	Profile popups Noise Layout Per page

Great Help - Thanks

mbusfield

4:14 26 Nov '06

I needed to allow the clearing of a time field so that i can recognise that no time had been entered so i used your code as a starting point and added a few specifics to make it 'time only' and made it a specific format to make it simpler for the user and so i can easily validate the text as a time. Thanks
Sign In·View Thread·Permalink

Suggested enhancements

VBProEd

8:45 31 Dec '05

Thanks for the simplistic code that was easy to read and modify for my purposes. There are several masked edit controls in this forum that honestly don't work or were poorly tested. I thought I would share the enhancements to my version for the stated valid reasons. My scope for these changes was around date formatting/editing.

1. If a user selects the entire field for delete (to re-type), the control should clear out the entire field. Once the user starts typing, the mask automatically fills in and the user can start typing the new date. Here is my code addition:

Protected Overrides Sub OnKeyDown(ByVal e As System.Windows.Forms.KeyEventArgs)

        Dim tmpset = Me.SelectionStart

 

        On Error Resume Next

     Select Case e.KeyCode

            Case Keys.Delete

                If Len(Me.SelectedText) = Len(Me.Text) Then

                    Me.Text = String.Empty

                    Exit Select

                End If                

                Me.Text = ""

                For a = tmpset To aMask.Length - 1

                    Select Case aMskMask.GetValue(a + 1)

                        Case ".", "-", "\", "/", ","

                            aMask.SetValue(aMask.GetValue(a + 2), a)

                            a = a + 1

                        Case Else

                            aMask.SetValue(aMask.GetValue(a + 1), a)

                    End Select

                Next

 

                aMask.SetValue(CType("_", Char), aMask.Length - 1)

 

                e.Handled = True

 

                Me.Text = ""

                For a = 0 To aMask.Length - 1

                    Me.Text += aMask.GetValue(a)

                Next

                Me.SelectionStart = tmpset

 

        End Select

 End Sub

2. With SQL Server, DateTime values with leading zeroes are stored as m/d/yyyy, mm/d/yyyy and m/dd/yyyy (no leading zeroes). This creates havoc in a control when attempting to edit the "as stored" value since most data entry is done heads down without concern of field delimiters. I added the following events to handle re-formatting the date when first entering then leaving the control. These events also handle any input field defined with a mask of ##/##/#### and the user does not enter the Century date value.

Note: You should always set the "MaxLength" property on MaskedBox to either 8 or 10 (for dates) so that the user can automatically move to the next control.

Protected Overrides Sub OnEnter(ByVal e As System.EventArgs)

     MyBase.Text = Me.FormatData(Me.Text())

End Sub

 

Protected Overrides Sub OnLeave(ByVal e As System.EventArgs)

     MyBase.Text = Me.FormatData(Me.Text())

End Sub

 

Protected Function FormatData(ByVal sText As String) As String

 

        If sText Is Nothing Or sText Is String.Empty Then

            Exit Function

        Else

            sText = sText.Replace("_", "")

 

            If Len(Me.Mask) < 10 Then

                Try

                    Dim MyDate As DateTime = CType(sText, Date)

                    Return MyDate.ToString("MM/dd/yy")

 

                Catch

 

                    Return sText

 

                End Try

            Else

                Try

                    Dim MyDate As DateTime = CType(sText, Date)

                    Return MyDate.ToString("MM/dd/yyyy")

 

                Catch

 

                    Return sText

 

                End Try

            End If

 

        End If

 

    End Function

3. For those folks using SQL Server with controls bound to datasets that don't want to show the "as stored" date value from SQL Server, add the following handler and subroutine for all date field reformatting in your form.

Note: User-Defined Date/Time Formats (Format Function) - Unlike previous versions of Visual Basic, the Format function characters are case-sensitive. "MM" is not the same as "mm".



AddHandler txtMyDateField1.DataBindings("Text").Format, AddressOf Format

AddHandler txtMyDateField2.DataBindings("Text").Format, AddressOf Format

 

Public Sub Format(ByVal sender As Object, ByVal e As Windows.Forms.ConvertEventArgs)

    'This subroutine converts any SQL Server timedate to mm/dd/yy format

    If Not IsDBNull(e.Value) Then

        Dim MyDate As DateTime = CType(e.Value, Date)

        e.Value = MyDate.ToString("MM/dd/yy")

    End If

End Sub

Enjoy!

Re: Suggested enhancements

RicardoPDV

1:45 3 Jan '06

great idea ! when i made this control i don't have know too much the framework.
Sign In·View Thread·Permalink

miguelfantastic

13:03 27 May '05

Hello, only word don´t number..how???? i need more
Sign In·View Thread·Permalink

Problem in Using this Control

namasteall2000

4:21 1 Oct '04

Hi, I have downloaded this control and using the same dll - but somehow I am not able to key in any thing from keyboard. As soon as I press any key from keyboard cursor moves further a place - but somehow it doesn't write anything. Could anyone helps me in finding the error? Urgent Help needed!!!!
Sign In·View Thread·Permalink	2.00/5 (1 vote)

Backspace Bug

AnAverageJoe

5:54 9 Jun '04

Great little project. One small problem. If you hit backspace when you are at possition 0, it jumps out to position 1. I added this test to OnKeyPress() event. That fixed the problem. If Asc(e.KeyChar) = 8 Then ' original code ' JPM added this check. ' The select start ended up at position 1 with out this. If (tmpset = 0) Then Exit Sub End If Thanks for the control, joe
Sign In·View Thread·Permalink

Re: Backspace Bug

MrGTI

4:32 1 Oct '04

Just so people know,... here is the first part of that sub, with the new code ....

      Protected Overrides Sub OnKeyPress(ByVal e As System.Windows.Forms.KeyPressEventArgs)
            On Error Resume Next
            Dim tmpset = Me.SelectionStart
            Dim tmpCH As Char
            If Me.ReadOnly = True Then Exit Sub

            If Asc(e.KeyChar) = 8 Then   'BACKSPACE
                  'If you are at position 0, this stops it from jumping out to position 1
                  If (tmpset = 0) Then Exit Sub

                  e.Handled = True
                  If Me.SelectionLength = 0 Then
                        If InStr(ALLOW_CHARS, CType(aMskMask.GetValue(tmpset - 1), String), CompareMethod.Text) > 0 Then
                              tmpset = tmpset - 2
                              aMask.SetValue(CType("_", Char), tmpset)
                              tmpset = tmpset - 1
......

Re: Backspace Bug

buffbuh

12:54 28 Mar '07

Thanks so much for the BACKSPACE solution "Asc(e.KeyChar) = 8" - for some reason, "e.KeyChar.Equals(Keys.Back)" and everything else I tried did not work, and it took me a long while to find your solution here. Thanks!
Sign In·View Thread·Permalink

Absolutely Clueless....

TheKanuck

3:02 27 May '04

Nice control. Just wondering if it is possible to have the control accept more than just /'s and -'s as part of the mask? For example, creating a mask like this: ###-aaa/&&&(##) The mask does work, but it forces the user to account for the a's when entering the data into the field. Any help you can give would be greatly appreciated.
Sign In·View Thread·Permalink

Re: Absolutely Clueless....

Xpto001

18:24 29 Oct '04

try this: http://www.codeproject.com/useritems/MaskedTextBox.asp[^]
Sign In·View Thread·Permalink

Poor Control Load

MrGTI

4:30 23 Sep '03

There are 2 bugs with this code. Cry | :((

1) When the control loads, the mask is not used when a value is assigned. You can test this by: In the Form_Load event, assign a value to the control. When the form appears, the mask has NOT been used.

2) Using the same code you have in the above example, when the form appears CLICK anywhere in the control to release the highlight, and then press the Backspace key. All the text in the control is deleted.

I can tell you've done a lot of work, but this control is far from being a "final release". Sorry.

Update: I went through it and i added in a totally new procedure that fixes the errors. Just add this extra code in and rebuild the app.



    Public Sub SetTextWithUnmaskedText(ByVal sText As String)

        'Use this sub to apply text to the control when incoming text does not have the mask already in it.

        'For example, during Form_Load, pass in the phone number without dashes or brackets.

        On Error Resume Next

        If sText = "" Then

            For a = 0 To tmpMask.Length - 1

                If tmpMask.Substring(a, 1) = "#" Or tmpMask.Substring(a, 1) = "&" Then

                    aMask.SetValue(CType("_", Char), a)

                Else

                    aMask.SetValue(CType(tmpMask.Substring(a, 1), Char), a)

                End If

            Next a

        Else

            Dim iPos As Integer = 0

            For iLpr As Integer = 0 To tmpMask.Length - 1

                If tmpMask.Substring(iLpr, 1) = "#" Or tmpMask.Substring(iLpr, 1) = "&" Then

                    aMask.SetValue(CType(sText.Substring(iPos, 1), Char), iLpr)

                    iPos += 1

                Else

                    aMask.SetValue(CType(tmpMask.Substring(iPos, 1), Char), iLpr)

                End If

            Next iLpr

        End If

 

        Me.Text = ""

        For iFill As Integer = 0 To aMask.Length - 1

            Me.Text += aMask.GetValue(iFill)

        Next iFill

    End Sub

Re: Poor Control Load

namasteall2000

4:13 1 Oct '04

Hi, I have downloaded this control and using the same dll - but somehow I am not ab;e to key in any thing from keyboard. As soon as I press any key from keyboard cursor moves further a place - but somehow it doesn't write anything. Could anyone helps me in finding the error? hi
Sign In·View Thread·Permalink

BUG

balu_vee

3:34 14 Aug '03

hi man just remove the . or - etc and type some thing see bala
Sign In·View Thread·Permalink

Re: BUG

namasteall2000

4:14 1 Oct '04

Hi, I have downloaded this control and using the same dll - but somehow I am not ab;e to key in any thing from keyboard. As soon as I press any key from keyboard cursor moves further a place - but somehow it doesn't write anything. Could anyone helps me in finding the error? hi
Sign In·View Thread·Permalink	2.00/5 (1 vote)

Option strict please

nemaroller

4:18 30 Apr '03

I haven't yet tried the component, but it looks good for what I will use it for, save me some time anway. But please be revise your code with Option Strict On, you have quite a few implicit conversions in there... and implicit declerations.
Sign In·View Thread·Permalink

Re: Option strict please

namasteall2000

4:14 1 Oct '04

Hi, I have downloaded this control and using the same dll - but somehow I am not ab;e to key in any thing from keyboard. As soon as I press any key from keyboard cursor moves further a place - but somehow it doesn't write anything. Could anyone helps me in finding the error? hi
Sign In·View Thread·Permalink

small bug ???

zefrit

7:13 22 Apr '03

cool, nice component, regardless have a look to the delete key effect, i think it add a mask character to the default mask... Exemple MASK = # ### ### ### Your text box mask = _ ___ ___ ___ If you delete all character with suppr key then text box mask = _____________ ???
Sign In·View Thread·Permalink	2.67/5 (3 votes)

Help me

namasteall2000

4:19 1 Oct '04

Hi, I have downloaded this control and using the same dll - but somehow I am not ab;e to key in any thing from keyboard. As soon as I press any key from keyboard cursor moves further a place - but somehow it doesn't write anything. Could anyone helps me in finding the error? hi
Sign In·View Thread·Permalink

Small bug

Richard Deeming

3:18 20 Jan '03

The Keys enumeration doesn't exactly match the ASCII character codes. For example, try using the number pad.

Also, you need to take the modifier keys into account - try holding down shift and typing in a numeric box.

Since you only need to worry about numbers and letters, you could try something like:

Protected Overridable Function GetCharFromKeys(ByVal key As Keys) As Char
    Dim keyCode As Keys = key And Not Me.ModifierKeys
    Select Case keyCode
        'A-Z
        Case Keys.A To Keys.Z
            If key And Keys.Shift Then
                Return Char.ToUpper(Chr(keyCode))
            Else
                Return Char.ToLower(Chr(keyCode))
            End If
        
        '0-9
        Case Keys.D0 To Keys.D9
            If key And Keys.Shift Then
                Return Chr(0)
            Else
                Return Chr(keyCode)
            End If
        
        '0-9 (number pad)
        Case Keys.NumPad0 To Keys.NumPad9
            'NumPad0 - D0 = 48
            Return Chr(keyCode - 48)
        
        Case Else
            Return Chr(0)
    End Select
End Function
... 
Dim tmpCH As Char = GetCharFromKeys(e.KeyData)
...