Most Valuable Professional


View Jan Karel Pieterse's profile on LinkedIn subscribe to rss feed
Subscribe in a reader

Subscribe to our mailing list

* indicates required

File crashes Excel!!

Save my workbook!
The best tool for salvaging problematic workbooks.

Trainings

Excel VBA Masterclass (English)
Excel VBA for Financials (Dutch)

Third party tools

Speed up your file

FastExcel
The best tool to optimise your Excel model!

What has changed?

PerfectXL Compare, for Spreadsheet Comparison
This Excel compare tool is fast, reliable, and easy to use. Compare two Excel files now and see for yourself!
Home > English site > Articles > Treeview control

An MSForms (all VBA) treeview for Access, Excel And Word

Introduction

If you have ever used the Treeview control from the "Additional controls" section, then you know what a versatile control this is to show hierarchically organized data. There are a couple of problems with this Treeview control:

  1. Compile errors due to a difference in how the control libraries are registered in 32 bits Windows' System32 and 64 bit Windows' SysWOW64 folders. If you distribute a file that was saved in 64 bit Windows, containing one of the "Microsoft Windows Common Controls 6.0" (The Treeview control is one of them) and with the reference set to "mscomctl.ocx", people using 32 bit Windows will almost certainly have problems. At best it could entail removing both the control and the reference and replacing both, but at worst the user's Excel can crash when trying to load the file and run the app.
  2. The standard Treeview control, like all non built-in ActiveX controls, cannot be used in 64 bit versions of Office.

Especially the second point convinced me it is time to develop a custom-made Treeview "control", that only uses the native Office forms controls. I started building this a couple of weeks ago and after some time I tricked Peter Thornton into helping me with it

The screenshot below shows both our new Treeview (left) and the Windows one (right) side-by-side in their simplest display mode (read on, there are even prettier screenshots further down the page):

Treeview controls
Two treeviews, left: VBA tree, right: Common controls tree

In the following pages I'll show what our treeview can do and explain how to put it to use in your own VBA project.

MAC Office and 64 bit Office Compatible!

Our treeview was tested (and works) on 64 bit Office. It also works on MAC office. Tested applications include:

Excel 2000
Excel 2003
Excel 2010
Excel 2010 (64 bit)
Excel 2011 (MAC Office)
Excel 2013 (32 bit)
Excel 2016 (32 and 64 bit)

Access 2003
Access 2010 (32 bit)
Access 2010 (64 bit)
Access 2016 (32 bit)

Windows screenshot:

Treeview demo on Windows Excel
Treeview demo on Windows Excel

Mac screenshot:

MAC screenshot of our treeview demo form
Screenshot of treeview on Mac Excel 2011

Acknowledgements

The basic plumbing and code structure of this treeview control was devised by me. However, without the help of my friend and fellow MVP Peter Thornton, lots of functionality would not have been available now. For that I sincerely thank Peter!

Furthermore, Access MVP Ben Clothier was kind enough to make the necessary adjustments to incorporate the treeview in an Access form

Also: Fellow Excel MVP Ron De Bruin ensured the treeview also works on MAC Office 2011, Thanks Ron!

Copyright and Licensing

All code in the treeview is (c) JKP Application Development Services and Peter Thornton (the Authors). It remains our sole intellectual property.

However, we're offering this treeview to you at no cost. You get an unrestricted license for use in any VBA project you like. You're free to modify any part of the code at will.

We do have some rules:

And please mention the source of the treeview (including a link to this page) in your helpfile, manual and/or on your about screen.

We're always interested to see how people have implemented the VBA Treeview. So please feel free to send a screenshot with a brief description or relevant details.

Disclaimer

You use this control at your own risk: The authors accept no liability whatsoever for any damages which may arise due to the use of our treeview.

Donations

Many, many hours were spent developing this treeview. Although we developed it for use in our own projects, we are giving it away for free!

Nevertheless, we would really be pleased if you actually express your appreciation in a more "tangible" form. So here is a paypal donation button at your disposal:

Download

The Excel workbook contains most of the documentation (on the tabs of the workbook), so I recommend you to at least download the Excel version. The Access version has instructions on its main form (click the "How do I...?" button) on how to implement the treeview in your own projects.

Download the treeview sample Excel workbook (including documentation) (build 026, 15 Oct 2015, downloaded 38.884 times)

Download the treeview sample Word document (build 026, 15 Oct 2015, downloaded 12.287 times)

Download the treeview sample Access database (build 026, 16 Oct 2015, downloaded 31.737 times)

‘Pro’ Treeview and ListGrid VBA controls

The professional version of the treeview control has exceptional performance. Even with tens of thousands of nodes it will load quickly and remain highly responsive. It also has several new features including drag and drop. Timing experiments have proven that the pro version of our treeview outperforms the common controls treeview.

Our new ListGrid combines most of the functionality of the ActiveX Listview and Flexgrid controls with many extra useful features. It is the result of extensive beta testing by some of our treeview users, thanks guys!

The screenshot of the demo below gives an idea of just some of its capability.

Professional ListGrid control

The Pro Treeview and ListGrid are available for 32/64 bit Excel and Access. The Excel version will also work in Mac, one or two features are disabled for Mac but we’re working on it. Unlike our free treeview they are self contained in their own files and designed to work more like real controls.

For more details and if interested in a trial license to try either of these ‘controls’ please contact us:

Pro Treeview enquiry

Pro Listgrid enquiry

Please note that the pro versions are paid versions. Pricing available upon request by using the links above.

Content

 

Other controls

Another often used control is the calendar control. This control has the added problem that it has been deprecated with Office 2010 (where we're supposed to use the date picker control). Frankens Team created an all-vba alternative using very similar techniques to what we've done here.

Ron de Bruin created a Date Picker control for MAC Excel.


Comments

Showing last 8 comments of 778 in total (Show All Comments):

 


Comment by: Peter Thornton (16-5-2020 12:02:00)

Hi Ayush,

Does nNode refer to a node (clsNode) that already exists, if so-
What is the value of vData(lRow, lLevel) when the error exists. If lRow and lLevel are within the bounds of the array, can the element value be converted to a string with, for example Null and error values can't be.

 


Comment by: Brian (17-6-2020 02:29:00)

I have used MS Access Treeviews for years. My company just updated to 64 bit Office and everything stopped working. I found your tool with an internet search. I looked through your code and it looks very promising.

In looking at your code, it looks like a separate query is used for each level in the tree. I currently have a single table setup to control my trees. The structure is...
NodeID: numeric value with no duplicates
ParentID: numeric value - 0's are root nodes. Child nodes contain the NodeID for the root it belongs under (may be several levels deep)
NodeOrder: numeric value to sort Nodes of a given level in the correct order
NodeText: text to display for the node in the three
NodeObjectType: Form, Query, Report, etc. (used if clicking on a node will open another object)
NodeObjectName: name of Access table, form, query, etc. (used if clicking on a node will open Access object)
NodeImage: icon to display in tree


With rs
     While Not .EOF
         strKey = !NodeID & ";" & Nz(!NodeObjectType) & ";" & Nz(!NodeObjectName)
         If !ParentID > 0 Then
            TreeView0.Nodes.Add(getNodeIndex(!ParentID), tvwChild, strKey, !NodeText).ForeColor = 16711680 ', CStr(!NodeImage)
         Else
            TreeView0.Nodes.Add , tvwLast, strKey, !NodeText, CStr(!NodeImage)
         End If
    
         .MoveNext
     Wend
End With


Is there a way to adapt this tool to load a treeview off of a single table set up in this manner? Using this method allows us to add new items to the tree very easily, with no worry as to whether we have enough levels built into the VBA code.

Thank you for your assistance.

 


Comment by: Peter Thornton (17-6-2020 10:30:00)

Hi Brian,

In the 'pro' version nodes can be added in any order, even before their before prospective parents were added. But if I follow, in your code it looks like child nodes are always added to an existing parent (except root nodes which are added with 'tvwLast'). If so, try replacing the following in your code:

TreeView0 > mcTree, or your name for the WithEvents clsTreeview reference.
Nodes.Add > NodeAdd
tvwLast > tvLast
tvwNext > tvNext

 


Comment by: Jan Karel Pieterse (17-6-2020 10:32:00)

Hi Brian,

You definitely can do that, you just need to adapt your current code to use the properties and methods of our tree rather than the common controls one. Instead of using AddChild, check out our implementation of the NodeAdd method, as that allows you to specify the key of the parent node.
I advise you to download the Excel sample as that has more extensive documentation.

 


Comment by: Brian (20-6-2020 01:15:00)

Peter and Jan Karel, thank you for your assistance. I got my treeview to populate and function as desired. I have one additional question. With the ActiveX treeview, I had buttons on my form to expand/collapse all nodes. Is there a way to do this with your tool without rebuilding the entire tree (I can make it work by rebuilding the tree and adding cNode.Expanded = True/False (depending on button pressed)? I would rather not have to rebuild the entire tree if there is another way to accomplish this task.

Thank you

 


Comment by: Jan Karel Pieterse (22-6-2020 10:28:00)

Hi Brian,

There is an "ExpandToLevel" method for expanding/collapsing the tree to a certain nodelevel.

 


Comment by: Raphael Love (8-8-2020 14:10:00)

Is there a way to let sub procedure from standard module to control mcTree?


Thank you for your assistance.

 


Comment by: Peter Thornton (9-8-2020 13:21:00)

Yes, several ways. You could maintain a reference to the form in the normal module, and call a public method in the form; either process the mcTree reference in the form or return a copy of mcTree to the normal module. Or you could maintain a copy of the mcTree reference in the normal module.

Whichever approach you go for it'll be important to ensure any references in the normal module (to the form or the treeview) are destroyed when the form closes, in particular ensure that TerminateTree gets called.

 


Have a question, comment or suggestion? Then please use this form.

If your question is not directly related to this web page, but rather a more general "How do I do this" Excel question, then I advise you to ask your question here: www.eileenslounge.com.

Please enter your name (required):

Your e-mail address (optional, will only be used to inform you when your comment is published or to respond to your question directly):

Your request or comment (max 2000 characters):

To post VBA code in your comment, use [VB] tags, like this: [VB]Code goes here[/VB].

I give permission to process this data and display my name and my comment on this website accoring to our Privacy Policy.