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

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

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

 


Comment by: Peter Thornton (15-12-2019 11:16:00)

Hi Jamie,

1) Apply default formats (incl font) as required for the background, they will also be inherited by default by node labels:
mcTree.TreeControl.BackColor = RGB(240, 250, 255)

Apply before calling Refresh.

2) With the Access version there can be issues with focus, mainly while developing (if that's what you mean by 'Objectwindow') but also after alt-tab'ing windows, though usually not a problem in use. It's a lot of work to change and not viable to add to the free version, the 'pro' version is much better in this respect.

 


Comment by: Jamie (19-12-2019 18:14:00)

I have a need to open the tree to a specific node (rather than to a specific level). I have the node's key. I have tried:
Set .ActiveNode = .Nodes("key")
but it only appears to work if the parents of the node are all expanded.

Is there a way to have the tree expanded "down" to a specific node?

 


Comment by: Peter Thornton (19-12-2019 19:56:00)

Hi Jamie,

After setting the active node call .ScrollToView

Also see ScrollToView in the documentation and search this page for same.

 


Comment by: Jamie (2-1-2020 15:50:00)

Is there a way to disable the mcTree control? I have another subform, called "ObjectWindow" on the same parent form as the subTreeview subform (A sibling form, if you will). I don't want people be able to click on nodes in the tree while I am editing data in subform "ObjectWindow", so I would like to disable it.

 


Comment by: Peter Thornton (2-1-2020 16:11:00)

Hi Jamie,

mcTree.TreeControl.Enabled = False


If that might confuse the user maybe hide it completely with .Visible = False when going into some obvious different mode.

 


Comment by: Hervé Vuillaume (13-1-2020 11:16:00)

Hi,
That you for your treeview, I'm currently working for implementing it in a big Word macro.
I use treeview because I need lists with icons.

But I have 2 remarks:
- could you add an option to totally remove the root node ?
- could you add also an option for having a double click if the treeview is not in edit mode ?

For the double_click, I had modified the function like this :

Private Sub mctlControl_DblClick(ByVal Cancel As MSForms.ReturnBoolean)
' PT a node label has been double-clicked, enter edit-mode if manual editing is enabled
    Dim bDummy As Boolean

        If moTree.EnableLabelEdit(bDummy) Then
            moTree.EditMode(Me) = True
            EditBox bEnterEdit:=True
        Else
            If Me.Tree.AppName = "frmSelectDocType" Then
                Call frmSelectDocType.tvwFiles_DblClick
            End If
            ' moTree.NodeEventRouter Me, "Caption", tvDblClick
        End If
End Sub


Thanks in advanced and thank you for your code.

 


Comment by: Peter Thornton (13-1-2020 20:43:00)

Hi Hervé

#1 To delete or remove a root node use mcTree.NodeRemove cNode, where cNode refers to the root node (or any other node) you want to delete.

There's an example in the demo, select the node and press Delete on the keyboard, see the mcTree_KeyDown event.

#2 You've correctly uncommented mcTree.NodeEventRouter the node label's DblClick event. In NodeEventRouter in clsTreeview also uncomment the following
Else tvDblClick
RaiseEvent MouseAction

In the declarations uncomment:

And in your form add the MouseAction stub from the right dropdown which should now appear when you select mcTree in the left dropdown.

You can use the 'MouseAction' example to pass all events, if you prefer make and raise your own dblClick event.

 


Comment by: Peter Thornton (13-1-2020 20:46:00)

Re #2, I forgot:
In the declarations uncomment:
Event MouseAction

 


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.