Excel VBA 2010 Lesson 6: Subroutines and Functions

TwitterShare/Bookmark

[Lesson 5][Table of Contents][Lesson 7]

We have learned how to write code for the command button in the Excel VBA 2010 editor. Another way to write code in Excel VBA 2010 is to go to the code window directly by clicking on View Code in the Developer menu bar. In the editor window, click on insert module to start code that is not related to an Active-X control.

Module is a code sheet that is specific to your Excel VBA. Code created in the module is not directly triggered by events on the spreadsheet, but need to be called directly. It can be called by running a macro, press F5 , running a UserForm etc. If the code is a function, it can be inserted directly into the cells of the spreadsheet.

A Excel VBA 2010 project usually uses one or more nodules to store the necessary subroutines or functions know as procedures. You can make the subroutines or functions private or public. If the code is private, it can only be used by the current workbook whereas a code that is made public can be use by other procedure in another module in the workbook.


 6.1: Subroutines

A Subroutine in Excel VBA 2010 is a procedure that performs a specific task and to return values, but it does not return a value associated with its name. However, it can return a value through a variable name. Subroutines are usually used to accept input from the user, display information, print information, manipulate properties or perform some other tasks. It is a program code by itself and it is not an event procedure because it is not associated with a runtime procedure or an Excel VBA control such as a command button. It is called by the main program whenever it is required to perform a certain task. Sub procedures help to make programs smaller and easier to manage.

A Subroutine begins with a Sub statement and ends with an End Sub statement. The program structure of a sub procedure is as follows:

Sub subProg(arguments)

Statements

End Sub

Subroutines are called by the main program using the Call keyword.

Sub MainProg( )

Call  SubProg()

End Sub

A subroutine is different from a function that it does not return a value directly. You can include parameters in a subroutine.

Example 6.1

In this example, the main program calls the subroutine findHidden  and execute it. The end result is a message box that display the hidden text.

Private Sub CommandButton1_Click()
Call findHidden
End Sub
Sub findHidden()
hidden_txt = “@#%43&*”
MsgBox hidden_txt
End Sub


Example 6.2

Private Sub CommandButton1_Click()

Call salary(10, 300)

End Sub

Sub salary(wage As Single, hours As Single)
MsgBox wage * hours
End Sub

In this example, the Call command calls the subroutine salary and passes the parameters 10 and 300 to it. It will calculate the salary based on wage per hour and number of hours and display on the message box.



6.2 Functions

In Excel VBA 2010, a function is similar to a subroutine but the main purpose of the function is to accept a certain input from the user and return a value which is passed on to the main program to finish the execution. There are two types of functions, the built-in functions (or internal functions) and the functions created by the programmers, or simply called user-defined functions.

The first built-in function that we have already learned and familiar with its usage is the Message Box. We are not going to repeat here but we shall take a look at its syntax once more, i.e.

message=MsgBox(Prompt, Style Value,Title)

Now we shall  examine the next commonly used function in Excel VBA,  the InputBox function.

6.2.1 InputBox function

An InputBox( ) function displays a message box where the user can enter a value or a message in the form of text. The format is

myMessage=InputBox(Prompt, Title, default_text, x-position, y-position)

myMessage is a variant data type but typically it is declared as string, which accept the message input by the users. The arguments are explained as follows:

  • Prompt       – The message displayed normally as a question asked.
  • Title            – The title of the Input Box.
  • default-text  – The default text that appears in the input field where users can use it as his intended input or he may change to the message he wish to key in.
  • x-position and y-position – the position or the coordinate of the input box.

Example 8.1

In this example, we insert a label and a command button into the MS Excel spreadsheet. Double click on the command button and enter the Excel VBA code as follows:

Private Sub CommandButton1_Click()
Dim userMsg As String
userMsg = InputBox(“What is your message?”, “Message Entry Form”, “Enter your messge here”, 500, 700)
If userMsg <> “” Then
MsgBox( userMsg)
Else
MsgBox(“No Message”)
End If
End Sub

* The InputBox  is show in Figure 6.1

vba2010_fig6.1

Figure 6.1: InputBox

6.2.1 Creating User Defined Functions

The syntax to create a function is as follows:

Public Function functionName (Arg As dataType,……….) As dataType

or

Private Function functionName (Arg As dataType,……….) As dataType

* Public indicates that the function is applicable to the whole project while Private indicates that the function is only applicable to a certain module or procedure.

In order to create a user-defined function in Excel VBA, you need to go into the Visual Basic Editor in MS Excel Spreadsheet. In the Visual Basic Editor, click on Insert on the menu bar to insert a module into the project. Enter the following code  as shown in Figure 6.2. This function is to calculate the cube root of a number.

vba2010_fig6.2

Figure 6.2

Now enter the function CubeRoot just like you enter the formula of MS Excel, as shown in Figure 6.3. The value of cube root for the number in cell C4 will appear in cell D4.

vba2010_fig6.3

 

We will deal with more user-defined functions in future

[Lesson 5][Table of Contents][Lesson 7]