Similar to what we have in worksheet as Concatenate function and the & command which is used to join two or more than two strings together, in VBA we use Join command to do so, in Join in VBA we take source of the data in an array and similar to the concatenation we use a delimiter to join them.
Excel VBA JOIN Function
As the name itself suggests, the VBA JOIN function is used to join together an array of substrings with the specified delimiter. If we do not specify any delimiter, then it takes ‘space’ as a default delimiter character. It does the same work as Concatenate function does in Excel except we have to specify delimiter character once only whereas, in Concatenate function, we have to specify delimiter character every time in between every two strings.
The syntax of the function is
As we can see, the function takes two arguments and returns a string. Arguments are:
- SourceArray: We need to specify or give reference to an array of substrings that are to be joined.
- Delimiter: The delimiter is used to separate each of the substrings when creating up the resultant string. As this is an optional argument, if we omit it, the delimiter is set to be a space ” “.
The VBA SPLIT function is an exact opposite function of the VBA JOIN function.
Examples of VBA Join Function
Below are the examples of join function in Excel VBA.
VBA Join – Example #1
Suppose, we want to join the first (Ramesh), middle (Kumar) and last name (Mishra).
Steps would be:
- First, we need to open the visual basic editor. We can do the same by clicking on ‘Visual Basic’ command in the ‘Code’ group under the ‘Developer’ tab or we can use the excel shortcut key Alt+F11.
- Insert the module by right-clicking on a “sheet 1” and choosing ‘Insert’ command from the contextual menu and then choose ‘Module’ to insert.
- Create a subroutine named ‘JoiningName’.
Sub JoiningName() End Sub
- Use the JOIN function as follows
Sub JoiningName() Range("D2").Value = Join(Array("Ramesh", "Kumar", "Mishra")) End Sub
We can see that we have used ARRAY function to provide SourceArray to the JOIN function and skipped to specify the delimiter character so ‘space’ would be default character. The processed value of the JOIN function will be written in cell D2 when we execute this code using the F5 key or manually.
VBA Join – Example #2
Suppose, we want to create various excel files with the item name containing sales only for that item.
- Open the Visual Basic Editor using shortcut key Alt+F11.
- Right click on ‘Sheet1′ (Example 2)’ sheet to open the contextual menu and click on ‘Insert’ to insert a VBA ‘Module’ in the VBA project.
- Define a subroutine named ‘CreateItemSoldFiles’.
Sub CreateItemSoldFiles() End Sub
- We need to set a reference to ‘Microsoft Scripting Runtime’ object library using Tools menu -> References… command, as we will use some code (objects), which will not work if we do not include this object library.
- Now we will declare all the variables.
Dim FSO As New Scripting.FileSystemObject
The above FSO variable gives access to the VBA FileSystemObject. After binding, we can use functions like BuildPath, CopyFile, CreateTextFile, etc.
- The next statement creates a TextStream object. Through the TextStream object, we can read from or append to the original file.
Dim FSO As New Scripting.FileSystemObject Dim ts As Scripting.TextStream
- We will declare more variables. ‘r’ is for holding rows in the range, ‘fs’ is for storing final joined string, ‘cols’ for storing numbers of columns in the range, ‘FolPath’ for storing the path of the folder so that we can save the files in the folder and ‘Items_Sold’ for storing various item names to create file with these names.
Dim r As Range Dim fs As String Dim cols As Integer Dim FolPath As String Dim Items_Sold As String
- To count the total number of columns in range, we will define the following statement.
cols = Range("A1").CurrentRegion.Columns.Count
This statement will first select the current region for cell A1 and then will count the total number of columns in the current region.
- We will write the following statements for assigning the variable ‘FolPath’ a path using ENVIRON function and Concatenation Operator.
FolPath = Environ("UserProfile") & "\Desktop\Items_Sold" If Not FSO.FolderExists(FolPath) Then FSO.CreateFolder FolPath
The second statement will create the folder if the folder does not exist in the same location.
- This code will assign the values of B column one by one to ‘Items_Sold’ We have used ‘OFFSET function’ to get the reference of cell in B column as the currently selected cell is in column A.
Items_Sold = r.Offset(0, 1).Value
- The following bordered statement will open the files with names stored in ‘Items_Sold’ variable in one by one in appending mode (the new values will be appended at last).
Set ts = FSO.OpenTextFile(FolPath & "\" & Items_Sold & ".xls", ForAppending, True)
We have used Concatenate operator with variables ‘FolPath’ and ‘Items_Sold’ and static values (“\” and”.xls”) to create file names for excel files.
- We need to keep in mind that VBA JOIN function takes an only one-dimensional array as SourceArray To convert the rows into a one-dimensional array, we need to use Application.Transpose method two times.
fs = Join(Application.Transpose(Application.Transpose(r.Resize(1, cols).Value)), vbTab)
We have used the Resize method of range object to resize the range to the width of a number of columns in the range.
As delimiter, we have used ‘vbTab’ keyword so that values would be filled in different cells.
- As we have stored the processed value of JOIN function into ‘fs’ variable, we will write the fs’s values into new lines of VBA created excel files for every row in our original file from row number 2 to the last row (in our case it is 350th row).
- Before ending the loop, we will close the file opened. The code would be as shown in the screenshot.
We have written the full code now.
Sub CreateItemSoldFiles() Dim FSO As New Scripting.FileSystemObject Dim ts As Scripting.TextStream Dim r As Range Dim fs As String Dim cols As Integer Dim FolPath As String Dim Items_Sold As String cols = Range("A1").CurrentRegion.Columns.Count FolPath = Environ("UserProfile") & "\Desktop\Items_Sold" If Not FSO.FolderExists(FolPath) Then FSO.CreateFolder FolPath For Each r In Range("A2", Range("A1").End(xlDown)) Items_Sold = r.Offset(0, 1).Value Set ts = FSO.OpenTextFile(FolPath & "\" & Items_Sold & ".xls", ForAppending, True) fs = Join(Application.Transpose(Application.Transpose(r.Resize(1, cols).Value)), vbTab) ts.WriteLine fs ts.Close Next r End Sub
Now to execute the code, we will press F5 then, we can see that a folder named ‘Items_Sold’ has been created with the help of VBA code on the desktop.
In the folder, there are 7 unique files created with the names of the item and we can find out details about only that particular item in files.
Things to Remember About VBA JOIN Function
- The SourceArray must be a one-dimensional array. We cannot refer to an individual cell, as this will create multiple multi-dimensional arrays.
- If we specify a zero-length string (“”) as a delimiter, all items in the array are concatenated with no delimiters.
This has been a guide to VBA Join. Here we learn how to use VBA Join Function to join together an array of substrings with the specified delimiter along with examples & downloadable templates. Below are some useful articles related to VBA –