Microsoft Office OneNote 2007 import/export XML schema. For more information regarding the OneNote 2007 API please visit: http://msdn.microsoft.com/office/program/onenote/ Note that all values are in points. © 2006 Microsoft Corporation This is the top-level root node which contains all of the OneNote hierarchy items. This will include notebooks, the Unfiled Notes section, currently Open Sections and any Live Sharing Sessions. The Unfiled Notes section is the default location for unfiled notes.This section may or may not appear in a user's notebook and by default is not part of one of the user's set of notebooks. If this section is in a user's notebook the Unfiled Notes will not appear in the export XML, instead you would need to use the GetSpecialLocation method to get the path to the Unfiled Notes section. When any item is currently in viewed in the OneNote UI this property will be set to true, otherwise it will not appear in the export XML. Open Sections contains all of the currently opened sections in OneNote. These sections are automatically closed when OneNote exits. If there are no open sections then this will not appear in the export XML. Any section which is currently open in a notebook will not appear in the Open Sections. When any item is currently in viewed in the OneNote UI this property will be set to true, otherwise it will not appear in the export XML. Live Shared Sections contains a copy of live sharing sections in which the user participated. Copies of sections for previous sessions will be read-only, only live sharing sessions are editable. These sections do not exist on disk only in the OneNote offline cache so they don't have a path parameter. If there are no Live Shared Sections then this will not appear in the export XML. When any item is currently in viewed in the OneNote UI this property will be set to true, otherwise it will not appear in the export XML. A notebook is the top-level container for sections and section groups. Notebook contain sections, which are individual files, and section groups, which are subfolders in a notebook. The nickname for the notebook, viewable in the notebook properties dialog. Color of the notebook as it appears on the navigation bar. By default the automatic color is chosen and OneNote will assign the color to the notebook. A section group is a subfolder within a notebook, which will contain individual section files or additional subfolders which are section groups. A section is an individual file which contains pages. Color of the section. By default the automatic color is chosen and OneNote will assign a color to the section. Sections can be password protected, if they are then the encrypted attribute will be true. You cannot encrypt a section via the API, you would need to do that from within OneNote. Password protected sections are locked until the user unlocks them. If a section is unlocked then it may be accessible from the API. Users can also specify that all password protected sections are locked from the API, however this isn't the default option. Specifies if this section is read only. When OneNote loads content from the source into the OneNote cache it does so in the background. When the section isn't fully loaded this attribute will be false and once everything is loaded it will be true. This doesn't mean the content is fully in sync with the mater copy, only that it has synced once. A page is the surface for all the user's content. The timestamp for when the page was created. If all or part of the page is selected this attribute will be set. If a page is a subpage then this attribute will be set to true. Subpages and pages are identical in the API save for this property. OneNote search uses Windows Desktop Search and OneNote sends pages to the WDS indexer. One of the parameters to the search method calls is to include unindexed pages or not, if these parameters are set then unindexed pages will be returned and this attribute will be set on those unindexed pages. Otherwise this attribute is omitted. The title is the text or recognized text that appears in the title area on the top of a page. Only ink and text are valid data types for the title area. Selection information for the title. Page settings for the page. Specifies if the page layout is right-to-left or not. Specifies the background color for the page. Settings for the page size. When creating a new page you can omit this element and OneNote will use the default automatic settings for the page size based on the locale. Sets the page orientation, by default page orientation is set to portrait. The default orientation is portrait. Defines the page dimensions. All values are in points. Sets the page margins, by default the top and bottom are set to 36 and left and right are set to 72. All values are in points. Settings for the rule lines on the page. By default rule lines appear on OneNote running on a Windows Tablet PC. When creating new pages and you want to pick up the system default for rule lines then set this to automatic. If you are specifying rule lines then you are required to set this parameter and if you are showing rule lines this should be set to true. Settings for rule lines which include color and spacing. RuleLineSettings are used for both vertical and horizontal rule lines. There are various rule line options in OneNote, by default the spacing is to 23.76 points. You can look in OneNote to see the different rule line spacing options. Settings for margin lines which include color. The rule margin is the vertical line that goes along the margin and typically is a blue color. The base type for all page level object. All PageObjects can have metadata associated with them with the Meta element. A unique ID given to each page level object, they are only unique on a page but not throughout all pages. New page level objects should omit this attribute. Selection information for the PageObject. Last modified time for the PageObject. Extends the PageObject and defines which page level objects support tags and media linking. Media linking is the audio/video recording feature found under the Insert menu. Contains the ink serialized format (ISF) of an ink drawing. When importing the data is either referenced in a file or is included in line (Base64 encoded). New ink imported into OneNote can only be imported as an InkDrawing so that OneNote can properly lay it out on the page. If the isUnclassifed attribute is set to true OneNote will run ink analysis on the ink when the user navigates to the page, this will allow the ink to be searchable in OneNote. It may also change the InkDrawing into an InkParagraph or InkWord. When importing ink that you want converted to handwriting set this attribute to true. Note that hand writing recognition only occurs on machines that have the Windows Tablet feature installed. inkOriginX is the offset of the ink within an ISF from the position of the InkDrawing. Typically inkOriginX are the default value of 0 for ink drawings atleast for InkDrawings created in OneNote. inkOriginY is the offset of the ink within an ISF from the position of the InkDrawing. Typically inkOriginY are the default value of 0 for ink drawings atleast for InkDrawings created in OneNote. Shape information for InkDrawings which specifies their anchor point. Anchor point for ShareInfo which contains the x, y position. The x position relative to the page origin. The y position relative to the page origin. Definition of inserted files in OneNote. For new files inserted into OneNote you only need to specify the pathSource attribute. When exporting a page with inserted files and you want to get that file use the pathCache attribute to get the files from the OneNote offline cache. The filename in the OneNote cache might be different from the preferred name so make sure to supply that attribute otherwise OneNote will change the filename on import. Definition of an images which can either be on a page or in an OE. The data is either referenced in a file, is included in line as Base64 encoded or referenced to a CallbackID. Images in OneNote may have OCRData which contain the OCR recognized text that appears in the image or that was set via the API. Images sent to OneNote via the Send to OneNote 2007 print driver will set the isPrintOut attribute to true and will also set the mdiFileIndex, mdiPageNumber and originalPageNumber attrubutes, when importing your own images you need not supply this. Images sent to OneNote via the Send to OneNote 2007 print driver will set the isPrintOut attribute to true and will also set the mdiFileIndex, mdiPageNumber and originalPageNumber attrubutes, when importing your own images you need not supply this. Images sent to OneNote via the Send to OneNote 2007 print driver will set the isPrintOut attribute to true and will also set the mdiFileIndex, mdiPageNumber and originalPageNumber attrubutes, when importing your own images you need not supply this. Images sent to OneNote via the Send to OneNote 2007 print driver will set the isPrintOut attribute to true and will also set the mdiFileIndex, mdiPageNumber and originalPageNumber attrubutes, when importing your own images you need not supply this. If the image is set to be a background image on the page this attribute will be true. Images in OneNote may contain image OCR information such as the text that appears in the image. Alternatively OCRText can be set via the API. Note that when OneNote performs OCR it may contain HTML information that cannot be accessed by the XML and if you set the OCRText information via the XML you cannot set the HTML information only plain text. Specifies the language in ISO 639 format. When OneNote does image OCR OneNote will store where that OCR hit occurred in the image. This allows OneNote search to highlight the text in the image so that users can easily find their search terms. This information is stored in the OCRToken information. It has one token per word in the OCRText. It contains all the information to highlight the text such as the starting position, region, line, x, y, width and height. Definition of a table which is stored in an OE. Selection information for the table. Contains the information about the columns in a table. Information about an individual column in a table, such as the index location, width and if the width is locked or not. By default the widths of columns are unlocked and can be resized as the user types content into a cell. Once the user as sized or resized a column width this attribute is set to true. Contains the cells in an individual row in a table. Contains the OEChildren in an individual cell. Definition of an outline on a page. Lists the number of indents for this outline. Defines the indents. Defines the indent level. OEChildren are collections of outline elements (OE) which share the same parent and indenting level. OEChildren are in either an outline or an outline element. The default indent level is 1 for all OEChildern. Default indent is 1. A single outline element (OE) or a single line of text. OEs contain most of the content on a page including images, tables, all forms of ink, media files (audio/video), text and of course additional levels of OEs in OEChildren. Individual OEs can be right-to-left which may or may not be the same as the page setting. By default it set to the page RTL setting. The bodyText is related to the outline features in OneNote, see outlining toolbar for more info. The collapsed is related to the outline features in OneNote, see outlining toolbar for more info. The collapsedBodyText is related to the outline features in OneNote, see outlining toolbar for more info. Collection of layout settings for OEs. All of these settings are for the outline, how much spacing should there be, etc. These options can be found on under Format-->List. The T type for all text in OEs. TextRanges should be escaped by putting the information in CDATA blocks. TextRanges can also contain HTML for formatting information and information stored in spans. InkParagraphs are collections of InkWords that are grouped together but they cannot be parsed into individual InkWords. This is usually due to slanted handwriting which causes OneNote to group the text together. As with InkWords, InkParagraphs should not be created outside of OneNote as it will most likely cause layout problems. InkWords are the ink which is in an OE or InkParagraph and is typically handwriting. InkWords are an ISF of each individual word the user has written and they are together either in an OE. InkWords should not be created or modified outside of OneNote and reimported. This will cause layout problems, only use InkDrawings to import new ink into OneNote. As with InkDrawings the data will be an in line base 64 ISF or a CallbackID. Additionally you can have ink spacing and end of line elements. When OneNote is running on a machine with Windows Tablet features the ink will be recognized for text. The recognized text will be in this attribute. X coordinate for the top of the ISF relative to the PageObject (outline). Y coordinate for the left side of the ISF relative to the PageObject (outline). inkOriginX is the offset in the ISF for the ink blob. When rendering ink from OneNote take the ISF and use this inkOriginX to start drawing the ink. This inkOriginX is starting at the top-left of the bounding box for the ISF. inkOriginY is the offset in the ISF for the ink blob. When rendering ink from OneNote take the ISF and use this inkOriginY to start drawing the ink. This inkOriginY is starting at the top-left of the bounding box for the ISF. A space for use with ink. End of line for use with ink. List information (either a bullet or a number). Defines the bullet style with an integer. For the types of bullets found in OneNote open Format-->Bullets. Defines the number list format. This includes the sequence, number format, font information and text. For the types of numbered lists found in OneNote open Format-->Numbering. Defines the tags on the page. This defines the index and name of the tag that is used throughout the XML. If the page contains any tags then the TagDef information must be included on import or it will fail. The type is 1 if the tag is a to-do tag that can be marked as completed and 0 otherwise. The symbol is the offset in the tag gallery. A single instance of an applied tag, the index maps back to the TagDef definitions. A single instance of an applied Outlook task. It includes the GUID that OneNote inserts into the task in Outlook and the task start and due dates. There can only be one OutlookTask per OE. Definition of an media file in OneNote. Media files in OneNote are the audio or video recordings that allows the user to record something while taking notes at the same time. The notes will link to that point in the audio so that the notes and media are in sync. Media files are an extension to inserted files. When importing you don't need to supply a MediaRefernece GUID as OneNote will assign one accordingly. A unique GUID on the page for this MediaRefernece. When importing new media content omit this and OneNote will assign a unique GUID automatically. A sorted list of media references on the page. A single instance of an media timestamp. timeIndex is in milliseconds since when the recording started. A reference to a media file as a GUID that OneNote creates. Defines a single Microsoft Document Imaging file. Used by the Send to OneNote 2007 print driver. Defines a single name/value data pair that can be applied to almost any item on a page as well as hierarchy elements. To delete a meta value reimport the existing name but leave the content attribute blank which will delete that data. The name will continue to be on the page. The name of a meta element, max length of 256 characters. Note that if an individual word is longer than 64 characters it will not be indexed Windows Desktop Search and the FindMeta method will not work. The content for a meta element, max length of 262144. Positive number. OneNote will not export HTMLBlocks, they are only used to import HTML content into OneNote. During import OneNote will parse the HTML and convert into OneNote formats (tables, OEs, images, etc). The representation of an object to be used for identification of objects on a page. Not unique through OneNote, but unique on the page and the hierarchy. Globally unique identifier. Represents the path to a file. The representation of a color - either the text string None or Automatic or a # followed by a 6 digit hex value. Color value is specified by pairs of values in the order Red, Green, Blue. Type of image being exported: auto, png, emf or jpg. Representation of selection - three possible values: none: No selection on this object or any of its children partial: This object contains at least one selected object all: This object is selected (or all its children are selected) Position of an object: x, y, z. The z ordering starts at 1 and each page level item continues to have a higher number. Each new item on a page has a higher z-order than the previous item. The greater the z-order the higher it appears on the page. Size of an object. Used when not fully exporting all of the binary data out of OneNote. When reimporting XML which doesn't contain all of the binary data you need to omit the CallbackIDs in certain cases otherwise OneNote will fail to import. Any elements that are direct children of the page will work just fine if a CallbackID is specified on reimport. Any elements that are descendents of an outline will cause an error to be thrown if a CallbackID is specified. To resolve that get the full page information from GetPageContent. The automatic setting. Each of these properties apply to a T/TextRange element or to anything which may have a T/TextRange as a child. The attribute used for a given T/TextRange element will be the last attribute seen before (or on) the element. Language is in ISO 639 format. Defines the properties which specify who edited what when. If not set on a child element, it has the same setting as the parent. The author information is not displayed in the right-click context menu. All times are in GMT. Default attributes for all hierarchy items: ID, name, lastModifiedTime and isCurrentlyViewed. isCurrentlyViewed will be set to true for each item currently viewed by the user. When viewing a page there will be a currently viewed notebook, section and page. There will be no currently viewed page if OneNote is only running with the API and without a window frame. Defines the file object attributes. Attributes that are common to action items (tags and Outlook tasks). Defines the alignments: left, center and right.