MFC Tree State Manager using XML

• Download source files - 6 Kb
• Download demo project - 86 Kb

Introduction

A vast majority of successful applications use the tree control to display a variety of information to the user. The tree control has become so ubiquitous that the users are very familiar with its operations. One of the common problems with the tree control is saving the state between sessions. This article presents a class TBTreeStateMgr that makes it effortless to save and restore the state of multiple trees.

What is a tree state ?

The tree state consists of

• The expanded state, which nodes are expanded and which are collapsed
• The selection state, which nodes are selected
• The visibility state, which nodes are currently visible

Currently, the TBTreeStateMgr only stores the expanded state.

Highlights

The following are the highlights of TBTreeStateMgr implementation:

• Can handle multiple tree instances
• Each tree instance must be assigned a unique tree ID
• Uses XML to store/load the tree states
• All methods in TBTreeStateMgr are declared static. This is due to the fact that a single instance of TBTreeStateMgr can handle storage of a number of tree states.
• TBTreeStateMgr is threadsafe
• Uses COM Structured Storage to store individual XML files

Using TBTreeStateMgr

1. Include the following header file in your project

   #include "TBTreeStateMgr.h"

2. Ensure that CoInitialize or OleInitialize is called in the InitInstance function

   ///////////////////////
   
   // Init COM
   
   CoInitialize(NULL);

3. Place this code in the InitInstance function of your MFC application

   ///////////////////////////////////
   
   // Initialize the TBTreeStateMgr //
   
   TBTreeStateMgr::Initialize();

4. Place this code in the ExitInstance() function

   ///////////////////////////////////
   
   // Uninitialize
   
   TBTreeStateMgr::Uninitialize();

5. To save the tree state simply call  

   BOOL TBTreeStateMgr::SaveTreeState(LPCTSTR lpszTreeContextName,CTreeCtrl * pTreeCtrl);

   Note: This function is typically called before quitting the window. For example: by processing the WM_CLOSE message.

   //This call saves the specified tree instance. "My Tree1 View" is the name of the instance.
   
   TBTreeStateMgr::SaveTreeState(_T("My Tree1 View"),&wnd_TreeCtrl);

6. To restore the tree instance to its saved state simply call

   BOOL TBTreeStateMgr::LoadTreeState(LPCTSTR lpszTreeContextName,CTreeCtrl * pTreeCtrl);

   Note: This function is typically called just after initializing the tree control with the data For example: in the OnInitialUpdate() function

   //This call restores the wnd_TreeCtrl to a state stored under the name <code>"My Tree1 View"
   
   TBTreeStateMgr::LoadTreeState(_T("My Tree1 View"),&wnd_TreeCtrl);

7. [OPTIONAL] Change the storage file.

   The TBTreeStateMgr by default stores the Structured Storage file in the current directory under the file name "CTLStateStg.ctss", if you want to specify a different directory or path use the SetStorageFile(LPCTSTR lpszNewFile)

   // Change the storage file location
   
   TBTreeStateMgr::SetStorageFile(_T("e:\\MyDir\\ILikeThisDir\\MyStorageFile.strg"));

To reset all tree states, simply delete the "CtlStateStg.ctss" file. This file will be automatically generated if it is not found

Implementation

This section describes in short some of the implementation choices I had to make. I hope my use of XML and IStorage/IStream in this project will demonstrate how powerful these tools are. Structured Storage is in fact used by MSWord. The DOC format is actually a IStorage compatible file.

Conventional approaches

There are many mechanisms to store and retrieve tree states. A popular approach seems to be to store the tree state in the registry. For document/view applications that use the tree control, some developers choose to store the latest tree state as part of the document. So each document will be able to restore its view to the state when it was last closed. The registry method is not secure, safe nor scalable. Most projects do not have the luxury of modifying the document file to accommodate storing the latest state. In any case, it is a bad idea to store the view state along with the document object.

Enter XML

While I was evaluating techniques to store the tree control state, I stumbled upon XML. XML is also highly tree structured. If we could somehow transfer the tree state to an XML document efficiently and back, we could have a really cool solution. The MSXML parser is highly efficient and widely available with IE5 deployments. The bulk of the code in TBTreeStateMgr is devoted to translating the tree state to XML and back. The XML DTD for this project is:

<!-- TBTreeStateMgr.dtd   --	The DTD for storing tree state -->
<!ELEMENT TreeState(ExpandedNodes)>
	<!ELEMENT ExpandedNodes(node*)>
	    <!ELEMENT node (#PCDATA)>
<!-- . . end . . -->

IStorage/IStream

The next major problem was : How to store multiple trees ?

If you open the CtlState.ctss using the "Docfile Viewer" we can see the following structure:

As the above figure shows, the DOCfile stores each XML document in a separate stream. The reason for this architecture is: Any large scale application would have to deal with multiple trees (or) with multiple users view of the same tree. An application may also have trees in the views of multiple documents. For example: Each book document can have a tree view showing the table of contents. If we created a different XML Document for each tree instance, we may end up with hundreds of files. Another reassuring factor was Structured Storage is used extensively by MS in its own products (MSWord/Excel store DOC,XLS files in Structured Storage)

Enhancements

This can be enhanced to support storage of any state. Just change the XML DTD to add elements of your own liking. For example: this can be enhanced to save/restore state of Toolbars, Windows, Splitter Windows, List, Grid.

You must Sign In to use this message board.

FAQ    Noise Tolerance Very HighHighMediumLowVery Low   Layout Expand Posts & RepliesThread ViewNo JavascriptNo JS + Preview   Per page 102550

Msgs 1 to 18 of 18 (Total in Forum: 18) (Refresh) FirstPrevNext

Error tupi_kasvala 3:18 19 Sep '07   Hi, It seems Interesting but while running it i found so many errors.i am sending my call stack.How to avoid it .Waiting for your early reply. ////////////////////////////////////////////////////////// D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(45) : error C2143: syntax error : missing ';' before '*' D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(45) : error C2501: 'pDoc' : missing storage-class or type specifiers D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(46) : error C2143: syntax error : missing ';' before '*' D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(46) : error C2501: 'pExpNodes' : missing storage-class or type specifiers D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(75) : error C2061: syntax error : identifier 'IXMLDOMDocument' D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(76) : error C2143: syntax error : missing ';' before '*' D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(76) : error C2086: 'IXMLDOMNode' : redefinition D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(76) : error C2061: syntax error : identifier 'IXMLDOMDocument' D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(76) : error C2501: 'AppendElementChild' : missing storage-class or type specifiers D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(77) : error C2143: syntax error : missing ';' before '*' D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(77) : error C2086: 'IXMLDOMNode' : redefinition D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(77) : error C2061: syntax error : identifier 'IXMLDOMDocument' D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(77) : error C2501: 'AddNamedElementChild' : missing storage-class or type specifiers D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(78) : error C2061: syntax error : identifier 'IXMLDOMDocument' D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(79) : error C2143: syntax error : missing ';' before '*' D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(79) : error C2086: 'IXMLDOMNode' : redefinition D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(79) : error C2061: syntax error : identifier 'IXMLDOMNode' D:\Trupti\GUI\StateMgrTreectrl\TreeStateSaverDemo\TBTreeStateMgr.h(79) : error C2501: 'GetChildElementByName' : missing storage-class or type specifiers Error executing cl.exe. TreeStateSaverDemo.exe - 18 error(s), 0 warning(s) //////////////////////////////////////////// Trupti Sign In·View Thread·PermaLink 1.50/5 (2 votes) can't run on my pc hillylf 20:07 14 Jan '04   After compiling it in my application and run, exception occurs (MFC Application has encountered a problem and needs to close. We are sorry for the inconvenience). When debug, I found it's due to this piece of code: ::EnterCriticalSection(&csection); Could somebody give me some help? Sign In·View Thread·PermaLink can't generate CTLStateStg.ctss hillylf 20:37 14 Jan '04   Moreover, in my PC, the default CTLStateStg.ctss isn't generated! What's wrong? Sign In·View Thread·PermaLink 2.00/5 (1 vote) cant run on my system kimyc 23:36 6 Apr '03   i try to run the demo project, but it ended up to be 131 erros, mostly cant detect the declaration for the xml format. Example: error C2143: syntax error : missing ';' before '*' in the (static IXMLDOMDocument * pDoc; // XML Document). I already install the msxml version 4, and also try to copy the msxml.dll into the same directory, but the same errors occured. Please help. it will help Sign In·View Thread·PermaLink 2.00/5 (1 vote) Re: cant run on my system suntiger 19:29 13 May '03   Add "using namespace MSXML" in the file "TBTreeState.h". You will get what you want. It is not necessary to install extra msxml.* if you use Windows 2000 or newer versions. Sign In·View Thread·PermaLink Re: cant run on my system William huang 6:32 30 Jun '03   add the following into your "stdafx.h" file #import named_guids using namespace MSXML; Sign In·View Thread·PermaLink Good job ! Ranjeet Chakraborty 12:58 15 Oct '02   Carved upon my stone, My body lies but still I roam... Sign In·View Thread·PermaLink Why not just store this info in the registry? Anonymous 11:21 5 Aug '02   Sign In·View Thread·PermaLink Re: Why not just store this info in the registry? Vivek Rajan 19:19 25 Aug '02   It is not a good idea to store enormous amounts of application specific data in the registry. - Vivek Sign In·View Thread·PermaLink Good... but does not compile on my m/c Bandu Patil 1:19 7 Jun '02   Mr. Vivek, Your article looks great, but the source simply does not compile on my machine; the IStream, IStorage and other interfaces are alien to my compiler. One more Que. where can I get the Docfile viewer? Thanks, Sign In·View Thread·PermaLink Had you found the solution? Knn 2:40 3 Jul '02   Hello. I faced the same problem as you. Had you found its solution? thank you.... Sign In·View Thread·PermaLink Re: Had you found the solution? Vivek Rajan 19:19 25 Aug '02   Sorry I didnt check these questions. What OS are you running ? Structure Storage has been integral to OLE for a long time. It is defined in OLE32.DLL Try this : In your stdafx.h file : #include #include then delete the following line if it is present #define VC_EXTRALEAN The basic idea is you must had included support for ActiveX and Automation in the AppWizard. Hope this helps Vivek Sign In·View Thread·PermaLink 1.00/5 (1 vote) Well done + a question Neville Franks 13:16 23 May '02   Hi Vivek, This looks like a good, clean and straightforward method to persist Tree control data. Thanks for sharing it with us. My only question is whether you have done any performance tests on large trees, say around +100K items. When I had a brief play with MSXML about 18 months ago it was useless for XML files this size. ie. It took forever to load the file, sometimes crashed, and when it did work it would use a ridiculous amount of memory. MS may well have addressed these issues by now but I haven't tried this since, so I don't know. The problem I saw may also not apply to your code. And finally you may well say this is irrelevant as you never intended it to be used for large collections, and that's fine. Neville Franks, Author of ED for Windows. www.getsoft.com Sign In·View Thread·PermaLink Re: Well done + a question Vivek Rajan 17:04 23 May '02   Neville- Thanks! There should be no problem storing large tree structures. The XML file contains only the nodes that have been expanded. I think it is reasonable to assume that even if a tree has 100K+ items, only a fraction of the nodes will be expanded. Also Microsoft has improved the MSXML parser a great deal recently. The main problem is the MFC Tree control is notoriously slow in DeleteAllItems. I tried the demo with 200K nodes on the far right hand tree (see the GUI picture in the article). I found that the XML storing/retreiving itself took 20ms. For 100K, the XML storage took 10ms. However, destroying the tree control took 8.1 secs for 100K nodes and 22s for 220K nodes. In my project, I use this tree state manager on trees which have 80K nodes. NO problem, because we use a look ahead loading mechanism, only load the expanded nodes and its children. I uploaded a new demo with 50K nodes, you can see that there is no overhead due to the XML storing. - Vivek Sign In·View Thread·PermaLink Re: Well done + a question Martin Bach 1:09 24 May '02   If You hide the TreeCtrl before calling DeleteAllItems (and of course show it again afterwards), the deletion is much quicker. Sign In·View Thread·PermaLink Re: Well done + a question Chris Maunder 23:08 25 May '02   You may want to check out Tibor Blazko's fast tree control cheers, Chris Maunder Sign In·View Thread·PermaLink Re: Well done + a question Neville Franks 3:47 28 May '02   Vivek, When I was working on the ClassView Tree in my programmer's editor, ED4W I had major problems with the MS Tree Ctrl. Populating the tree for the all of the classes/functions etc. in MFC/VC CRT could take over 30 minutes, which made it completely unusable. The Tree also gets updated in real time in a background thread and this was also taking too long to delete and insert items. This was with 100K+ items in the tree. In the end I wrote my own tree control which doesn't maintain any data in it's own right, and is simply a view into the real data which in this case is in a database I've written. This approach works extremelly well and it's speed is that of the underlying data source. For another post on this see A better way. Neville Franks, Author of ED for Windows. www.getsoft.com Sign In·View Thread·PermaLink Re: Well done + a question Vivek Rajan 19:21 25 Aug '02   Neville- Thanks for the comments. The main purpose of the article was not a high-speed tree control, but rather to store the state of the tree in a persistent way. I am sure this would work with your tree control also. Vivek Sign In·View Thread·PermaLink 1.00/5 (1 vote)

Last Visit: 16:23 23 Nov '09     Last Update: 16:23 23 Nov '09 1