Start using Code VBA

In this section we will walk through a programming sample to show how to use Code VBA to speed up coding.

Code VBA functionality is available from the toolbar and its menu.

Using Alt-key combinations significantly speeds up the use of the coding tools. menu

Note: It occurs sometimes that as a result of the way the Code VB toolbar is added to the toolbar area that not all buttons are displayed. If that is the case you can reorganize the toolbar area a bit to have full access.

Example rename files: renaming selected files in a folder

Description: loop through the files of a folder. If a certain condition is met rename the folder.

Create the procedure: error handling automatically added

add procedure

Result:

Notes:

Select the error handler you want to use from the list of available error handlers.
If absent and required the central error handling module is automatically copied in the project.
If you are not in the business of commenting your code, change Add Header Procedure setting.

Add the loop for processing files

Result:

Note:

required function is easily found from Shortcuts (Loop) the fragment builder is started with the relevant fragment
all variables are automatically created (press [Insert]) or can be linked to variables in the code

Insert variable to set the filespec

Result:

Next type in = "dlg*"

Note:

This demo was done in Excel, as can be seen by the 'implicit variables' present in the list (ActiveCell,...)
Insert Variable is especially useful for larger pieces of code where it is easy to loose track of what is available
In many cases MS built-in intellisense is just as good an alternative. One should use both, selecting whichever best fits the situation.

Assign Folder

a. select the variable to replace with string using double-click

b. start file selection from Shortcuts (dockable) dialog

c. select the folder

Result:

Add condition structure

Alt-CI[enter] inserts the If .. Then block.

Result:

The cursor is automatically at the correct location to start adding condition code

Find date function for condition

In this example we want only files before a certain date. We don't feel certain which function to use and try to find the correct one.

a. go to tab Search in dockable Shortcuts and Search dialog

Type 'file' and press [Enter]. Listed are all procedures and fragments which have something to do with file. (You could have added the word 'date' which would restict it further to all titles with file and date in it)

b. Double-click on FileDateTime starts the Line of Code Builder with that function selected.

Tab a few times and you will get the variable selection popup listbox opened

c. check how to use this function using [?] (on the dialog - next to [Help])

This opens the VB help on this function. OK, lets use this. Select strFilePath and press [Insert]

d. Finding the procedure to compare dates works the same way.

Notes:

Shortcuts and Search tab Shortcuts entry DateTime is more effective in finding date related functions.
Because I find it difficult to remember what the argument positions stand for I check 'Explicit Arguments' function in the builder. I select [Type text] in the variable poup listbox and enter the values for year, month and day.

Result:

Rename files

Let's assume I don't know how to rename files. I again use Search, now with 'rename'

There are two instances found:

The procedure I am currently working on, which happens to have 'rename' as part of it's name
The fragment which is stored in fragments folder 'Files and Folders' - let's use that.

I know the file I want to rename is in variable strFilePath. The second argument for name is the new name. I don't yet know how to get that name, but I make a <New Variable> for it:

Next OK on the Variable Builder and [Insert] on the Fragment Builder.

The variable is automatically added at the top of the procedure while the cursor is at the position for you to continue programming.

Final resulting code

(some empty lines removed to fit the page)