Input masks (for GUI dynamic input validation)

[GreenCan]

@GreenCan

Good work!

Just make one ZIP file (attachment) containing UDF+exxamples.for simple download.

Thanks, done...

[guinness]

A lot better. I just noticed (as I do when I look inside the UDFs) that a couple of 'issues' could be fixed.

1. In _Inputmask_init you have $iReturn, but it's not used so should be deleted.
2. In _Inputmask_init change Dim to Global, but ideally I wouldn't do that and instead would ReDim the array on initialising and closing.
3. If you decide you want to combine $sRegExpMask e.g.  $iIM_INTEGER + $iIM_ALPHA, then let us know and I will show you how with BitAND.

[GreenCan]

1. In _Inputmask_init you have $iReturn, but it's not used so should be deleted.

You are right, I forgot to remove the line when moving _Inputmask_MsgRegister() outside of the function.

Will be corrected in next upload

2. In _Inputmask_init change Dim to Global, but ideally I wouldn't do that and instead would ReDim the array on initialising and closing.

 

Init:

I understand that the use of DIM is discouraged, although I don't exactly understand what the reason is for not using Dim

I changed as follows, declare Global at the top of the UDF:

    #region Global variables

   Global $aInputMask[1][1], $iInputControls_count ; required Gloabal variables

   #endregion Global variables

and using ReDim in the init function

   ReDim $aInputMask[$iInputControls][6]

Closing:

You mean ReDim $aInputMask[1][1] instead of $aInputMask = "" ?

I understand that you don't like changing the vartype from array to a string, I don't like it neither. But what is the benefit of doing a ReDim $aInputMask[1][1]? This will leave one element containing some garbage.

Would it not be better to set $aInputMask=0 instead? Like you suggested here?

 

3. If you decide you want to combine $sRegExpMask e.g.  $iIM_INTEGER + $iIM_ALPHA, then let us know and I will show you how with BitAND.

Yes, might be of interest.

Thanks

Edited June 2, 2013 by GreenCan

[guinness]

Well if you know what you're doing then Dim isn't the worst thing in AutoIt, but it's just best to declare Local or Global exclusively. Here is >an example I created that displays when an error can occur due to the user not understanding the complications of Dim.

The changes you made are great, the 'issue' with changing the datatype wasn't what I was getting at initially, but I personally use $aArray = 0 when destroying an array or initialising an array/handle (for example.) As to the changes you've introduced, it's best to use ReDim in the closing function, because if a user decides to initialise the input mask function again, then an error will occur with the Init() ReDim.

As to my suggestion of combining mask values, you will need to change the values of constant variables to 1, 2, 4, 8, 16, 32, 64, 128....however many you have and then use the code below, adjusting depending on the constant variable.

This is an example only!

#include <Constants.au3>

Local Const $IM_INTEGER = 1, $IM_ALPHA = 2, $IM_SOMETHINGELSEIDUNNO = 4
Local $iFlagOrMask = $IM_INTEGER + $IM_SOMETHINGELSEIDUNNO ; BitOR($IM_INTEGER, $IM_SOMETHINGELSEIDUNNO) is preferred.

If BitAND($iFlagOrMask, $IM_INTEGER) = $IM_INTEGER Then MsgBox($MB_SYSTEMMODAL, '', '$IM_INTEGER was called.')
If BitAND($iFlagOrMask, $IM_ALPHA) = $IM_ALPHA Then MsgBox($MB_SYSTEMMODAL, '', '$IM_ALPHA was called.')
If BitAND($iFlagOrMask, $IM_SOMETHINGELSEIDUNNO) = $IM_SOMETHINGELSEIDUNNO Then MsgBox($MB_SYSTEMMODAL, '', '$IM_SOMETHINGELSEIDUNNO was called.')

Edited June 2, 2013 by guinness

[GreenCan]

As to the changes you've introduced, it's best to use ReDim in the closing function, because if a user decides to initialise the input mask function again, then an error will occur with the Init() ReDim.

Clear example. And yes, you are right.  I have to use ReDim in the UDF of course.

#include <Constants.au3>

Local Const $IM_INTEGER = 1, $IM_ALPHA = 2, $IM_SOMETHINGELSEIDUNNO = 4
Local $iFlagOrMask = $IM_INTEGER + $IM_SOMETHINGELSEIDUNNO ; BitOR($IM_INTEGER, $IM_SOMETHINGELSEIDUNNO) is preferred.

If BitAND($iFlagOrMask, $IM_INTEGER) = $IM_INTEGER Then MsgBox($MB_SYSTEMMODAL, '', '$IM_INTEGER was called.')
If BitAND($iFlagOrMask, $IM_ALPHA) = $IM_ALPHA Then MsgBox($MB_SYSTEMMODAL, '', '$IM_ALPHA was called.')
If BitAND($iFlagOrMask, $IM_SOMETHINGELSEIDUNNO) = $IM_SOMETHINGELSEIDUNNO Then MsgBox($MB_SYSTEMMODAL, '', '$IM_SOMETHINGELSEIDUNNO was called.')

This is also a clear example. Thanks.

I will have to check if this is useful in the UDF. Combination of any of the existing mask presets doesn't make sense I guess.

[GreenCan]

Hexadecimal mask: 

$sLabel_Mask = "14. Hexadecimal number(6)"
    GuiCtrlCreateLabel($sLabel_Mask, 10, 410, 200, 15)
    $Input_14 = GUICtrlCreateInput("",210,410,110,20)
    _Inputmask_add($Input_14,"[^A-Fa-f0-9]", 6, "U")

[guinness]

I will have to check if this is useful in the UDF. Combination of any of the existing mask presets doesn't make sense I guess.

That's true, each is pretty distinct for now. But who knows? Another project you might need something like this.

[GreenCan]

_InputMask Version 1.0.0.5 uploaded with better input control.

See Post 1 for download

Edited June 17, 2013 by GreenCan

[ViciousXUSMC]

Really like this so far.

I am not good with regex however so looking for a bit of guidance.

I want to tighten up a date input where the format must be MM/DD/YY

right now I am just using this to ensure its 8 characters long and can only use numbers and slashes.

_Inputmask_add($End, "[^0123456789/]", 8, "U")

I would like to tighten this up further if possible as people can still type bad dates.  

The most common would be not including the 0 for single digit months, so I think making the first character required as a 0 or 1 would help this but with RegEx I have no idea how to do it.

Also it seems we are working with "reverse" regex?  I looked up regex tutorials and ^ means "do not match" but this UDF lets me only type those characters.

Just learning as I go, but a little help can go a long way.

Thanks! 

Edited September 23, 2014 by ViciousXUSMC

[ViciousXUSMC]

No dice guys?

[GreenCan]

No dice guys?

Sorry, I missed this one because I didn't mark to follow the topic. have you found a way to solve your problem?

 

[ViciousXUSMC]

No, even though I tried to look at regex tutorials it seems that what I was learning in regex somehow applied opposite in this udf.

If I can learn how to fix it that would be great.

[GreenCan]

Well, I have also issues with regex, real hard stuff to get grip on.

May I ask you why you would bother creating an input mask for a date input, while you can use GUICtrlCreateDate?

 

[Jefrey]

For those who are having troubles with Undefined _Iif function, just add it to the UDF file:

Func _Iif($a, $b, $c)
    Return $a ? $b : $c
EndFunc

 

[Melba23]

Jefrey,

Better still - convert the lines use to ternary operator which replaced it.

M23

[ViciousXUSMC]

I was actually looking for this today.

I got a great answer from some of the forum members that did what I needed, but for the sake of learning I wanted to see if I could also use this UDF to produce the desired results.

As I was looking through the example I found I get an error in line 90/91 in regards to this function: _Iif

You can create the error by typing something into example section 2 (Integer) the error itself is from the UDF not the example

Regards,

Edited July 20, 2015 by ViciousXUSMC

[Melba23]

ViciousXUSMC,

The Iif function was replaced by the ternary operator a couple of releases ago. Just replace the function calls with the correct ternary syntax and everything will work.

M23

[ViciousXUSMC]

Well that works

Here is the fixed line 91 & 92 if anybody needs / is interested.

If StringLen($Read_Input) - StringInStr($Read_Input, "-") - (StringInStr($Read_Input, ".") ?  1 : 0) > $aInputMask[$i][4] Then ; Precision
                            $Read_Input = StringLeft($Read_Input, $aLocation[0] - 1) & StringRight($Read_Input,  $aInputMask[$i][4] + StringInStr($Read_Input, "-") + (StringInStr($Read_Input, ".") ? 1 : 0) - $aLocation[0] + 1)

 

[timmy2]

I appreciate the author's contribution of this UDF very much.  (And thank you to @‌ViciousXUSMC  for posting the ready-to-use "Undefined _Iif function" fix.)

For my level of expertise it would be wonderful if this thread had at least one simple, working example. The example included with the UDF is a fine overview of the UDF's capabilities but for a moron like me more is needed.

My code below "works" and it accomplishes what I wanted InputMask for, but I'd appreciate any suggested fixes and improvements as well as answers to the following:

1. The Example says: "Before using _Inputmask_add() don't forget to initialize the UDF with _Inputmask_init(x) where x is the number of input masks that you will create." In response, my brain thinks: "I want to limit the number of characters, I want to limit input to uppercase and  Alpha. That sounds like 3 criteria -- 3 "masks". Or, maybe the author means "the number of times I will use the InputMask function in my script"  What does "x" mean?

2. In the UDF, what is the purpose of the "_ImputMask" function when all examples use "_Inputmask_add"? 

3. When I compile or syntax check my code below the following warning appears. Ignore or what?

 

expandcollapse popup

#AutoIt3Wrapper_Au3Check_Parameters=-d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6

#include <GUIConstantsEx.au3>
#include <_inputmask.au3>
#include <Array.au3>
#include <ButtonConstants.au3>
#include <GUIConstantsEx.au3>
#include <WindowsConstants.au3>


Example ()


Func Example()

    Local $GUI, $sLabel_Mask, $MyInput
    #forceref $GUI, $sLabel_Mask
    Local $iInputs = 1

    _Inputmask_init($iInputs) ; Initialize InputMasks for Inputs controls
    _Inputmask_MsgRegister() ; Register for _InputMask

    $GUI = GUICreate("InputMask Example",373,230)
    GuiCtrlCreateLabel("Enter Drive Letter", 110, 40,190,33)
    GUICtrlSetFont(-1, 14, 600, 0, "MS Sans Serif")
    $MyInput = GUICtrlCreateInput("",175,96,33,32,$ES_CENTER)
    GUICtrlSetFont(-1, 14, 400, 0, "MS Sans Serif")
    Local $Button1 = GUICtrlCreateButton("OK", 296, 168, 49, 41,BitOR($BS_DEFPUSHBUTTON,$WS_BORDER))
    _Inputmask_add($MyInput, $iIM_ALPHA,1, "U")
    GUISetState()

    While 1
        Switch GUIGetMsg()
            Case $Button1
                ExitLoop
        EndSwitch

    WEnd

    _Inputmask_MsgRegister(False) ; Unregister for _InputMask
    _Inputmask_close() ; Memory cleanup for Input masks

EndFunc

 

Edited July 26, 2015 by timmy2
add #forceref, improve snippet

[guinness]

Are you telling me the warnings don't make sense? You're using advanced parameters for Au3Check, one of which is telling you about when a variable has been declared but not used. I don't know how to make the warnings anymore clearer.

This is why it's important that UDF creators (like me, you or everyone) run their UDF against these checks, as when someone like you or I decides to use this directive in our code, we don't get warnings. So the fix is to remove those variables and for those you can't remove like $iMsg or $hWnd, then use #forceref (search the help file for its usage).