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

Audit !!!

Check out our RefTreeAnalyser
the ultimate Excel formula auditing tool.

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!

Repair your file

Stellar Phoenix Excel Repair
Best tool to repair corrupt Excel sheets and objects
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)

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 35.795 times)

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

Download the treeview sample Access database (build 026, 16 Oct 2015, downloaded 29.170 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 737 in total (Show All Comments):

 


Comment by: Jan Karel Pieterse (9-10-2019 15:54:00)

Hi Joe,

Thanks for the kudos :-)
You're right, there is no NodeExists property or function. The good thing is that given that you get access to the source code it is quite easy to add the functionality yourself, simply add a routine to the clsTreeview class and you're good to go. I agree though, it is a collection so there is no Exists property and you still have to traverse the entire collection to find out if it is in there. We wanted to keep this VBA-only, so without any refs outside of the default Office ones.

 


Comment by: Filipe Caetano (9-10-2019 22:23:00)

Hello.
I know how to get all node's parent nodes by doing this:

    Dim cNode As clsNode
    Dim cParent As clsNode
    Set cParent = cNode.ParentNode
    Do While Not cParent Is Nothing
        Debug.print cParent.caption
        Set cParent = cParent.ParentNode
    Loop


But how do I loop through all node's child nodes recursively?
With this code I can only list the first sublevel child nodes of some given node:

    Dim cChild As clsNode
    For each cChild in cNode..ChildNodes
        Debug.print cChild.caption
     next cChild


I would like to have something like "CheckTriState" that when we check a node, all child nodes and their own child nodes are also indefinitely checked.

Thank you very much.
Filipe

 


Comment by: Jan Karel Pieterse (10-10-2019 11:59:00)

Hi Filipe,

You loop through childnodes recursively as you said:

Sub LoopChildren(cNode As clsNode)
    Dim cChild as clsNode
    If Not cNode.ChildNodes Is Nothing Then
        For each cChild in cNode.ChildNodes
            Debug.print cChild.caption
            LoopChildren cChild
        Next cChild
    End If
End Sub


The (un)checking of childnodes is already available, try the Excel demo and you'll see it in action. The demo without icons uses tristate checkboxes, the demo with icons uses non-tristate checkboxes.

 


Comment by: Filipe Caetano (10-10-2019 13:32:00)

Thank you very much Jan.

It works!
Great solution.

Regards,
Filipe Caetano

 


Comment by: Selami Demir (13-10-2019 18:23:00)

Dear authors of VBA treeview. I've used your control in one of my projects, which is an MS Excel VBA tool for wastewater treatment plant simulation. Your control helped me to easily design a userform on which simulation results are classified in treeview. I will publish my work in a scientific journal and I will add the following text to the acknowledgement. Is it Ok?

Thanks.

The acknowledgement text goes here:
The author would like to thank JKP Application Development Services and Peter Thornton (https://jkp-ads.com/Articles/treeview.asp) for creating a wonderful, all-VBA treeview control, which was extremely beneficial for implementing the userform to view the simulation results.

 


Comment by: Jan Karel Pieterse (14-10-2019 10:04:00)

Hi Selami,

Yes that is perfect. Would you be willing to post a reference to the published article here, once it is available on-line?

 


Comment by: Marcus (28-10-2019 21:22:00)

Hello,
verry nice tool. Thank you for your effort. Is it possible use it as a kind of file explorer. I used the MS treeview to navigate thru folders and files. How can I use your tool to do so?

 


Comment by: Jan Karel Pieterse (29-10-2019 11:52:00)

Hi Marcus,

It isn't very hard to replace the common controls treeview with ours, I suggest you study the demo Excel file and then just try to apply that to your own project. If you run into a problem, let us know and we'll try to help.

 


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.