Retrieving Page Metadata in OneNote 2010

Handy Programming Tips for Microsoft OneNote 2010: Learn how to retrieve page meta-data from Microsoft OneNote 2010.
Applies to: Microsoft OneNote 2010
Published: August 2011
Provided by: Frank Rice, Microsoft Corporation
Microsoft OneNote 2010 enables you to take and organize notes, include images and web pages, record audio, share your notes with others, and generally keep information from the many parts of your life organized within one simple application. In this topic, you use the GetHierarchy method to retrieve meta-data and data about the pages in a notebook. To complete this task, you must do the following:
Note |
|---|
To use the code in this topic, you need to run it from a Microsoft Office 2010 host program. These include Microsoft Excel 2010, Microsoft PowerPoint 2010, and Microsoft Word 2010. However, OneNote 2010 is not considered a host program. Excel is used in this topic. |
To add references to the workbook
Start Excel 2010.
On the Developer tab, click Visual Basic. This opens the Visual Basic Editor.
Note If you do not see the Developer tab in Excel, click the File tab, and then click Options. In the categories pane, click Customize Ribbon, select Developer, and then click OK.
On the Tools menu, click References.
Scroll to Microsoft OneNote 14.0 Object Library, and then select it.
Next, scroll to Microsoft XML, 6.0, select it, and then click OK.
In this task, you insert a standard module into the Excel workbook.
To add a standard module to the Excel workbook
On the Insert menu, click Module. This adds Module1 to the Projects pane on the left side of the Visual Basic Editor.
In this task, you add programming code to the Visual Basic Editor.
To add code to the Visual Basic Editor
In the Projects pane, click Module1.
Paste or type the following Microsoft Visual Basic for Applications (VBA) code into the module window.
Sub ListFivePagesFromFirstSectionOfFirstNotebook() ' Connect to OneNote 2010. ' OneNote will be started if it's not running. Dim oneNote As OneNote14.Application Set oneNote = New OneNote14.Application ' Get all of the Notebook nodes. Dim nodes As MSXML2.IXMLDOMNodeList Set nodes = GetFirstOneNoteNotebookNodes(oneNote) If Not nodes Is Nothing Then ' Get the first notebook found Dim node As MSXML2.IXMLDOMNode Set node = nodes(0) Dim noteBookName As String noteBookName = node.Attributes.getNamedItem("name").Text ' Get the ID so we can lookup the sections. Dim notebookID As String notebookID = node.Attributes.getNamedItem("ID").Text ' Load the XML for the sections for the notebook requested. Dim sectionsXml As String oneNote.GetHierarchy notebookID, hsSections, sectionsXml, xs2010 Dim secDoc As MSXML2.DOMDocument Set secDoc = New MSXML2.DOMDocument If secDoc.LoadXML(sectionsXml) Then Dim secNodes As MSXML2.IXMLDOMNodeList Set secNodes = secDoc.DocumentElement.SelectNodes("//one:Section") If Not secNodes Is Nothing Then Dim secNode As MSXML2.IXMLDOMNode Set secNode = secNodes(0) Dim sectionName As String sectionName = secNode.Attributes.getNamedItem("name").Text Dim sectionID As String sectionID = GetAttributeValueFromNode(secNode, "ID") ' Load the XML for the Pages for the Section requested. Dim pagesXml As String oneNote.GetHierarchy sectionID, hsPages, pagesXml, xs2010 Dim pagesDoc As MSXML2.DOMDocument Set pagesDoc = New MSXML2.DOMDocument If pagesDoc.LoadXML(pagesXml) Then Dim pageNodes As MSXML2.IXMLDOMNodeList Set pageNodes = pagesDoc.DocumentElement.SelectNodes("//one:Page") If Not pageNodes Is Nothing Then ' Print out data about the Notebook, Section, and first ' five pages of content. Debug.Print "Notebook Name: " & noteBookName Debug.Print "Notebook ID: " & notebookID Debug.Print " Section Name: " & sectionName Debug.Print " Section ID: " & sectionID ' Only show first five pages of information. Const MAX_PAGES = 5 Dim intPageCount As Integer intPageCount = 0 Debug.Print " *** Pages ***" Dim pageNode As MSXML2.IXMLDOMNode For Each pageNode In pageNodes Debug.Print " Page Name: " & GetAttributeValueFromNode(pageNode, "name") Debug.Print " ID: " & GetAttributeValueFromNode(pageNode, "ID") Debug.Print " Date Time: " & GetAttributeValueFromNode(pageNode, "dateTime") Debug.Print " Last Modified: " & GetAttributeValueFromNode(pageNode, "lastModifiedTime") Debug.Print " Page Level: " & GetAttributeValueFromNode(pageNode, "pageLevel") intPageCount = intPageCount + 1 If intPageCount = MAX_PAGES Then Exit For End If Next Else MsgBox "OneNote 2010 Page nodes not found." End If Else MsgBox "OneNote 2010 Pages XML Data failed to load." End If Else MsgBox "OneNote 2010 Section nodes not found." End If Else MsgBox "OneNote 2010 Section XML Data failed to load." End If Else MsgBox "OneNote 2010 XML Data failed to load." End If End Sub Private Function GetAttributeValueFromNode(node As MSXML2.IXMLDOMNode, attributeName As String) As String If node.Attributes.getNamedItem(attributeName) Is Nothing Then GetAttributeValueFromNode = "Not found." Else GetAttributeValueFromNode = node.Attributes.getNamedItem(attributeName).Text End If End Function Private Function GetFirstOneNoteNotebookNodes(oneNote As OneNote14.Application) As MSXML2.IXMLDOMNodeList ' Get the XML that represents the OneNote notebooks available. Dim notebookXml As String ' OneNote fills notebookXml with an XML document providing information ' about what OneNote notebooks are available. ' You want all the data and thus are providing an empty string ' for the bstrStartNodeID parameter. oneNote.GetHierarchy "", hsNotebooks, notebookXml, xs2010 ' Use the MSXML Library to parse the XML. Dim doc As MSXML2.DOMDocument Set doc = New MSXML2.DOMDocument If doc.LoadXML(notebookXml) Then Set GetFirstOneNoteNotebookNodes = doc.DocumentElement.SelectNodes("//one:Notebook") Else Set GetFirstOneNoteNotebookNodes = Nothing End If End Function
The ListFivePagesFromFirstSectionOfFirstNotebook procedure uses the MSXML library to parse the XML returned from OneNote 2010 and output the first notebook's page meta-data to the Immediate window of Excel.
In this task, you run the code.
To run the code
In the Visual Basic Editor, press F5 to run the code.
Examine the results in the Immediate window.