Export (0) Print
Expand All

Window Interfaces (OneNote 2010)

Office 2010

The Window and Windows interfaces are new Microsoft OneNote 2010 API objects that allow users to work with OneNote windows. These objects allow users to enumerate through the set of OneNote windows and modify certain window properties.

The following list shows the four view modes that you can use for OneNote windows:

  • Normal view—Displays the default OneNote window in which the Notebook and Page navigation panes are visible.

  • Full Page view—Displays a minimal user-interface (UI) view in which the Notebook and Page panes are not displayed.

  • Side note—Displays a small window that allows users to take quick notes. You would usually access side notes through the OneNote icon in the Windows notification area, but you can also access them through the View tab in OneNote.

  • Dock to Desktop— Displays a OneNote window that you can dock to any side of the desktop (similar to the taskbar). This view reduces the size of the desktop to fit the window. You can dock only one window at any time, and the window is always visible without blocking the desktop. This view is new in OneNote 2010.

Figure 1 shows what the Full Page view, Dock to Desktop view, and side notes look like on your desktop.

Figure 1. OneNote views

OneNote window views

This section lists the interfaces and members that you can use to modify OneNote windows programmatically.

Windows Interface

The Windows interface allows the user to access the set of opened OneNote windows. It is a property of the OneNote Application class, accessed through Application.Windows. This returns the enumerated set of OneNote windows.

Properties

Name

Type

Description

Count

ulong

Gets the number of Window objects in the Windows set.

CurrentWindow

Window

Gets the Window object of the active OneNote window.

Items

Window

Returns the Window object that corresponds to the index value passed. This property cannot be accessed directly. To return a Window object, use Windows [(uint) index].

Window Interface

The Window interface allows the user to access certain properties of each window. Each OneNote window can be accessed by enumerating through the Windows property of the Application class.

Properties

Name

Type

Description

Active

bool

Gets or sets a value that indicates whether the window is the active OneNote window.

Application

Application

Gets the OneNote Application object that is associated with the window.

CurrentPageId

string

Gets the object ID of the active OneNote page of the window.

CurrentSectionId

string

Gets the object ID of the active OneNote section of the window.

CurrentSectionGroupId

string

Gets the object ID of the active OneNote section group of the window.

CurrentNotebookId

string

Gets the object ID of the active OneNote notebook of the window.

DockedLocation

DockedLocation

Gets or sets the docked location of the OneNote window.

FullPageView

bool

Gets or sets a value that indicates whether the window is in Full Page view (minimal UI view).

SideNote

bool

Gets or sets a value that indicates whether the window is a side note window.

WindowHandle

ulong

Gets the handle ID of the OneNote window.

Methods

You can use the following methods of the Window interface to navigate to specified objects in the OneNote window or to specified URLs.

NavigateTo

Description

Navigates to the specified object in the OneNote window. For example, you can navigate to sections, pages, and outline elements within pages.

Syntax

HRESULT NavigateTo(
      [in]BSTR bstrHierarchyObjectID,
      [in]BSTR bstrObjectID);

Parameters

  • bstrHierarchyObjectID—The hierarchy OneNote ID of the object you want to navigate to. The object ID can reference a OneNote notebook, section, section group, or page.

  • bstrObjectID—The OneNote ID of the specific object to navigate to within a OneNote page. If the user does not want to navigate to a specific object on a page, this parameter is set to null.

NavigateToUrl

Description

If passed a OneNote link (onenote://), opens the OneNote window to the corresponding location in OneNote. However, if the link is an external link, such as http:// or file://, a security dialog box will appear. Upon dismissal, OneNote attempts to open up the link and an HResult.hrObjectDoesNotExist error is returned.

Syntax

HRESULT NavigateToUrl (
      [in]BSTR bstrUrl);

Parameters

bstrUrl—The URL to navigate to.

The following code iterates through the OneNote windows to find a docked window. If no docked window exists, the example docks the active window. If no active window exists, the code creates a new docked window.

using System;
using System.Diagnostics;
using Microsoft.Office.Interop.OneNote;

namespace SampleWND
{
    class DockOneNoteWindow
    {
        static void Main(string[] args)
        {
            Microsoft.Office.Interop.OneNote.Application app = new Microsoft.Office.Interop.OneNote.Application();

            // Search through all OneNote windows for a docked window and activate it.
            bool foundDockedWND = false;
            for (int i = 0; i < app.Windows.Count; i++)
            {
                if (app.Windows[(uint) i].DockedLocation != DockLocation.dlNone)
                {
                    foundDockedWND = true;
                    app.Windows[(uint) i].Active = true;
                }
            }
            
            // If no docked window exists, dock the active window.
            if (!foundDockedWND && (app.Windows.Count > 0))
                app.Windows.CurrentWindow.DockedLocation = DockLocation.dlDefault;

            // If no active window exists, create a new docked window.
            if (app.Windows.Count < 1)
            {
                Process oneProc = new Process();
                oneProc.StartInfo.FileName = "onenote.exe";
                oneProc.StartInfo.Arguments = "/docked";
                oneProc.Start();
            }
        }
    }
}


Show:
© 2014 Microsoft