Enumerations (OneNote developer reference)

This topic describes the enumerations in the OneNote 2013 object model.

CreateFileType

When passed to the OpenHierarchy method, specifies the type of object to create, if any, if the path passed to the method does not yet exist.

Member Value Description
cftNone
0
Creates no new object.
cftNotebook
1
Creates a notebook by using the specified name and location.
cftFolder
2
Creates a section group by using the specified name and location.
cftSection
3
Creates a section by using the specified name and location.

DockLocation

Indicates the docked location of a OneNote 2013 window by using the Window interface. When set to the DockedLocation property, specifies the location at which to dock a OneNote window. This enumeration is new in OneNote 2013.

Member Value Description
dlDefault
-1
The OneNote window is docked at the default location on the desktop.
dlLeft
1
The OneNote window is docked on the left side of the desktop.
dlRight
2
The OneNote window is docked on the right side of the desktop.
dlTop
3
The OneNote window is docked at the top of the desktop.
dlBottom
4
The OneNote window is docked at the bottom of the desktop.

FilingLocation

When passed to the SetFilingLocation method, specifies what type of content the filing location is set for when the content type is sent to OneNote. This enumeration is new in OneNote 2013.

Member Value Description
flEMail
0
Sets where Outlook email messages will be filed.
flContacts
1
Sets where Outlook contacts will be filed.
flTasks
2
Sets where Outlook tasks will be filed.
flMeetings
3
Sets where Outlook meetings will be filed.
flWebContent
4
Sets where Internet Explorer contents will be filed.
flPrintOuts
5
Sets where printouts from the OneNote printer will be filed.

FilingLocationType

When passed to the SetFilingLocation method, specifies where content that is sent to OneNote is filed. This enumeration is new in OneNote 2013.

Member Value Description
fltNamedSectionNewPage
0
Sets content to be filed on a new page in a specified section.
fltCurrentSectionNewPage
1
Sets content to be filed on a new page in the current section.
fltCurrentPage
2
Sets content to be filed on the current page.
fltNamedPage
4
Sets content to be filed on a specified page.

HierarchyElement

When assigned to the TreeDepth property of the IQuickFilingDialog interface, specifies the depth of the OneNote tree to display when the quick filing dialog is rendered. When passed to the AddButton method of the IQuickFilingDialog object, references certain elements in the OneNote hierarchy. This enumeration is new in OneNote 2013.

Member Value Description
heNone
0
Refers to no element.
heNotebooks
1
Refers to the Notebook elements.
heSectionGroups
2
Refers to the Section Group elements.
heSections
4
Refers to the Section elements.
hePages
8
Refers to the Page elements.

HierarchyScope

When passed to the GetHierarchy method, specifies the lowest level to get in the notebook node hierarchy.

Member Value Description
hsSelf
0
Gets just the start node specified and no descendants.
hsChildren
1
Gets the immediate child nodes of the start node, and no descendants in higher or lower subsection groups.
hsNotebooks
2
Gets all notebooks below the start node, or root.
hsSections
3
Gets all sections below the start node, including sections in section groups and subsection groups.
hsPages
4
Gets all pages below the start node, including all pages in section groups and subsection groups.

NewPageStyle

When passed to the CreateNewPage method, specifies the style of the new page.

Member Value Description
npsDefault
0
Creates a page that has the default page style.
npsBlankPageWithTitle
1
Creates a blank page that has a title.
npsBlankPageNoTitle
2
Creates a blank page that has no title.

NotebookFilterOutType

When passed to the NotebookFilterOut method of the QFD object, specifies what notebooks to display when the QFD box is rendered.

Member Value Description
nfoLocal
1
Allow only Local Notebooks.
nfoNetwork
2
Allows UNC or SharePoint Notebooks.
nfoWeb
4
Allows OneDrive notebooks.
nfoNoWacUrl
8
Any notebooks in locations that do not have a web client.

PageInfo (Updated for OneNote 2013)

When passed to the GetPageContent method, specifies the type of information to return with the page content.

Member Value Description
piBasic
0
Returns only basic page content, without selection markup, file types for binary data objects and binary data objects. This is the standard value to pass.
piBinaryData
1
Returns page content with no selection markup, but with all binary data.
piSelection
2
Returns page content with selection markup, but no binary data.
piBinaryDataSelection
3
Returns page content with selection markup and all binary data.
piFileType
4
Returns page content with file type info for binary data objects.
piBinaryDataFileType
5
Returns page content with file type info for binary data objects and binary data objects
piSelectionFileType
6
Returns page content with selection markup and file type info for binary data.
piAll
7
Returns all page content.

PublishFormat

When passed to the Publish method, specifies the format in which the published page will appear.

Member Value Description
pfOneNote
0
Published page is in the .one format.
pfOneNotePackage
1
Published page is in the .onepkg format.
pfMHTML
2
Published page is in the .mht format.
pfPDF
3
Published page is in the .pdf format.
pfXPS
4
Published page is in the .xps format.
pfWord
5
Published page is in the .doc or .docx format.
pfEMF
6
Published page is in the enhanced metafile (.emf) format.
pfHTML
7
Published page is in the .html format. This member is new in OneNote 2013.
pfOneNote2007
8
Published page is in the 2007 .one format. This member is new in OneNote 2013.

RecentResultType

When passed to the SetRecentResults method of the IQuickFilingDialog object, specifies what recent result list to display when the Quick Filing dialog box is rendered. Recent result lists are used to track the set of OneNote locations that the user selects in the Quick Filing dialog box. There are three recent-result lists in OneNote 2013 that track filing, search, and linking actions. This enumeration is new in OneNote 2013.

Member Value Description
rrtNone
0
Sets no recent-result list to be rendered.
rrtFiling
1
Sets the "Filing" recent-result list to be rendered.
rrtSearch
2
Sets the "Search" recent-result list to be rendered.
rrtLinks
3
Sets the "Links" recent-result list to be rendered.

SpecialLocation

When passed to the GetSpecialLocation method, specifies the special location path to get.

Member Value Description
slBackupFolder
0
Gets the path to the Backup Folders folder location.
slUnfiledNotesSection
1
Gets the path to the Unfiled Notes folder location.
slDefaultNotebookFolder
2
Gets the path to the Default Notebook folder location.

TreeCollapsedStateType

When passed to the TreeCollapsedState method of the QFD object, specifies whether the hierarchy tree should be expanded or collapsed.

Member Value Description
tcsExpanded
0
Sets the hierarchy tree to expanded.
tcsCollapsed
1
Sets the hierarchy tree to collapsed.

XMLSchema (Updated for OneNote 2013)

When passed to one of the following methods, specifies the version of the OneNote XML schema to use:

  • OneNote15.Application.GetPageContent

  • OneNote15.Application.FindMeta

  • OneNote15.Application.FindPages

  • OneNote15.Application.GetHierarchy

  • OneNote15.Application.GetPageContent

  • OneNote15.Application.UpdateHierarchy

  • OneNote15.Application.UpdatePageContent

Member Value Description
xs2007
0
References the OneNote 2007 schema.
xs2010
1
References the OneNote 2010 schema.
xs2013
2
References the OneNote 2013 schema.
xsCurrent
2
References the schema of the current OneNote version.
NOTE: We do not recommend using xsCurrent in most cases, as it can cause compatibility issues with future versions of OneNote. Instead specify the version of the schema that your app was built to handle, like xs2013.

See also