Application インターフェイス (OneNote)

Application インターフェイスには、OneNote の情報とコンテンツの取得、操作、および更新に役立つメソッドが含まれています。 こうしたメソッドは、次の 4 つの一般的なカテゴリに分けられます。

• ノートブック構造 – ノートブック、セクション グループ、セクションを検出、開く、変更、閉じる、削除する方法など、ノートブック構造を操作するためのメソッド。

• ページ コンテンツ – ページ コンテンツを検出、変更、保存、削除するためのページとページ コンテンツを操作するためのメソッド。 ページ コンテンツには、バイナリ オブジェクト (インクやイメージなど)、およびテキスト オブジェクト (アウトラインなど) が含まれます。

• ナビゲーション – ページとオブジェクトを検索、リンク、および移動するためのメソッド。

• 機能 – OneNote で特定のアクションを実行したり、パラメーターを設定したりするその他のすべてのメソッド。

さらに、Application インターフェイスには、いくつかのプロパティとイベントが含まれています。

ノートブック構造のメソッド

このセクションで説明するメソッドを使用すると、OneNote のノートブック、セクション グループ、およびセクションを探索、オープン、変更、クローズ、および削除できます。

GetHierarchy メソッド

GetHierarchy メソッドは、既定で OneNote 2013 XML 形式の文字列を返します。また、オプションの xsSchema パラメーターを使用して、優先 XML スキーマ バージョンを設定することもできます。

どのパラメーターを渡すかによって、GetHierarchy メソッドは異なるリストを返すようになります (たとえば、すべてのノートブック、すべてのノートブックに含まれるすべてのセクション、特定のセクション内のすべてのページ、特定のノートブック内のすべてのページなど)。 それぞれのノードごとに、プロパティ (セクションやページのタイトル、ID、最終更新時刻など) の情報を示す XML 文字列が返されます。

開始ノードと範囲の組み合わせには有効でないものがあります。 たとえば、セクションの開始ノードとノートブックの範囲を指定すると、ノード階層でのノートブックはセクションよりも上位になるため、GetHierarchy は Null の結果を返します。

次の C# の例は、GetHierarchy メソッドを使用して、すべてのノートブックを含む OneNote 階層全体をページ レベルまで取得する方法を示しています。 出力文字列はクリップボードにコピーされるため、その文字列はテキスト エディターに貼り付けて確認してください。

static void GetEntireHierarchy()
    {
        String strXML;
        OneNote.Application onApplication = new OneNote.Application();
        onApplication.GetHierarchy(null, 
            OneNote.HierarchyScope.hsPages, out strXML);
        Clipboard.SetText(strXML);
        MessageBox.Show("The XML has been copied to the clipboard");
    }

UpdateHierarchy メソッド

bstrChangesXmlIn パラメーターに部分的な OneNote XML 文字列のみを渡すと、OneNote は必要な変更を推論しようとします。 たとえば、1 つのセクションのみを含む Notebook 要素を含めると、OneNote は、そのセクションを既存のセクションの最後に追加します。 ただし、あいまいな操作の指定については、その結果を判断することが困難になります。 たとえば、既存のノートブックに 4 つのセクションが含まれているときに、そのノートブックと 4 番目のセクションおよび 1 番目のセクションのみが (この順序で) 含まれている XML 文字列を渡すと、OneNote は 2 番目と 3 番目のセクションを 4 番目のセクションの前に配置することも、1 番目のセクションの後に配置することもあります。

UpdateHierarchy メソッドを使用して、ノートブックの一部を削除することはできません。 つまり、既存の階層の一部のみを含む XML 文字列を渡しても、その文字列に含まれていないセクションは削除されません。 階層の一部を削除する場合は、DeleteHierarchy メソッドを使用してください。

次の C# コードは、UpdateHierarchy メソッドを使用して OneNote 階層を変更する方法の一例を示しています。このコードでは、既存のセクションの名前を変更します。 ここでは、ドライブ C のルートにある ChangeSectionName.xml というサンプル ファイルから XML コードを読み取って、XML ドキュメントに読み込んでから、そのドキュメントの XML 構造をメソッドに渡しています。

static void UpdateExistingHierarchy()
    {
        OneNote.Application onApplication = new OneNote.Application();
        
        // Get the XML from the file.
        XmlTextReader reader = new XmlTextReader("C:\\ChangeSectionName.xml");
        reader.WhitespaceHandling = WhitespaceHandling.None;
        XmlDocument xmlDocIn = new XmlDocument();
        xmlDocIn.Load(reader);
        
        // Update the hierarchy.
        onApplication.UpdateHierarchy(xmlDocIn.OuterXml,
        OneNote.XMLSchema.xs2007);   
    }

次の XML コードは、前述の C# コードでメソッドに渡した ChangeSectionName.xml ファイルの抜粋です。 この XML を UpdateHierarchy メソッドに渡すと、既存の階層に含まれるセクションの 1 つの名前が変更されます (name 属性の値が "My Renamed Section" に変更されます)。 その後で、名前を変更したもの以外のすべてのセクションが削除されます。 さらに、このコードではターゲットの Section 要素から不要な属性 (lastModifiedTime、isCurrentlyViewed、color などの属性) が削除され、属性の name、ID、および path のみがそのまま残されます。

<?xml version="1.0" ?> 
    <one:Notebooks xmlns:one="http://schemas.microsoft.com/office/onenote/12/2004/onenote"> 
        <one:Notebook name="My Notebook" nickname="My Notebook" ID="{0B8E7305-AC2C-4BCB-8651-1CDA55AAE14C}{1}{B0}"> 
            <one:Section name="My Renamed Section" ID="{5F4E2908-44BA-4C02-91FE-49FC665E9A33}{1}{B0}" path="C:\My Section.one" /> 
        </one:Notebook> 
    </one:Notebooks>

前述の XML コードは、GetHierarchy メソッドの例で示したコードを使用して取得したものですが、範囲をセクションに限定するために、次に示す変更が加えられています。

static void GetAllSections()
    {
        String strXML;
        OneNote.Application onApplication = new OneNote.Application();
        onApplication.GetHierarchy(System.String.Empty, 
            OneNote.HierarchyScope.hsSections, out strXML);
        Clipboard.SetText(strXML.ToString());
        MessageBox.Show("The XML has been copied to the Clipboard");
    }

次の C# の例は、"Sample_Section" という名前のセクションを検索し、ユーザーにセクションの新しい名前を入力するよう求め、 UpdateHierarchy メソッドを使用してセクション名をユーザーが入力した名前に変更する完全なコンソール アプリケーションを示しています。 コードを実行する前に、"Sample_Section" を OneNote 階層に存在するセクションの名前に変更します。

    static void Main(string[] args)
    {
        
        // OneNote 2013 Schema namespace.
        string strNamespace = "http://schemas.microsoft.com/office/onenote/2013/onenote";
        string outputXML;
        Application onApplication = new Application();
        onApplication.GetHierarchy(null, HierarchyScope.hsSections, out outputXML);
        // Load a new XmlDocument.
        XmlDocument xmlDoc = new XmlDocument();
        xmlDoc.LoadXml(outputXML);
        XmlNamespaceManager nsmgr = new XmlNamespaceManager(xmlDoc.NameTable);
            nsmgr.AddNamespace("one", strNamespace);
        // Search for the section named "Sample_Section".
        XmlNode xmlNode = xmlDoc.SelectSingleNode("//one:Section[@name='Sample_Section']", nsmgr);
        // Prompt for a new section title.
        System.Console.Write("Please enter a new title for the section: ");
        string input = System.Console.ReadLine();
        xmlNode.Attributes["name"].Value = input; 
        // Update the section with the new title.
        onApp.UpdateHierarchy(xmlNode.OuterXml);
        System.Console.Write("Done!\n");
    }

OpenHierarchy メソッド

開いているノートブックに含まれていないセクション グループを指定すると、OpenHierarchy メソッドはセクション グループをノートブックとして開きます。 開いているノートブックに含まれていないセクションを指定すると、OpenHierarchy メソッドは Recent Opened Sections セクション グループにセクションを開きます。 開いているノートブックに含まれているセクション グループまたはセクションを指定しても何も起こりません。そのセクション グループまたはセクションは既に開いています。 どの場合も、OpenHierarchy は指定されたセクション グループ、ノートブック、またはセクションのオブジェクト ID を返します。その ID は別の操作で使用できます。

また、新しいセクションを作成するために XML をインポートするのではなく、OpenHierarchy メソッドを使用することもできます。

次のコードは、OpenHierarchy メソッドを使用して、Work ノートブックの Meetings セクションを開いて、そのセクションの ID を取得する方法を示しています。 そのセクションが存在していない場合は、OneNote によって指定の場所にセクションが作成されます。

static void OpenSection()
    {
        String strID;
        OneNote.Application onApplication = new OneNote.Application();
        onApplication.OpenHierarchy("C:\\Documents and Settings\\user\\My Documents\\OneNote Notebooks\\Work\\Meetings.one", 
        System.String.Empty, out strID, OneNote.CreateFileType.cftSection);
    }

DeleteHierarchy メソッド

CreateNewPage メソッド

OneNote API の CreateNewPage メソッドは、利便性を目的として含まれています。 UpdateHierarchy メソッドを呼び出すことで、同じ結果が得られます。この場合は、新しいページの階層内での配置方法を細かく制御できます。 また、UpdateHierarchy メソッドを使用すると、新しいページの作成と同時にサブページも作成できます。

CloseNotebook メソッド

CloseNotebook メソッドを使用すると、指定したノートブックを閉じることができます。 このメソッドを呼び出すと、OneNote はオフラインのファイルを現在のノートブック コンテンツと同期します (同期が必要な場合)。その後で、指定のノートブックを閉じます。 このメソッドから復帰すると、そのノートブックは OneNote ユーザー インターフェイス (UI) の開いているノートブックのリストに表示されなくなります。

GetHierarchyParent メソッド

親オブジェクトが存在しない OneNote オブジェクトの場合 (ユーザーがノートブックの親オブジェクトを取得しようとした場合など)、例外がスローされます。

GetSpecialLocation メソッド

このメソッドを使用すると、[落書きノート] フォルダーのディスク上の場所がわかります。 OneNote は、OneNote にアイテムをドラッグして作成したノートや、別のアプリケーションから取り込んだノート (Microsoft Outlook や Microsoft Internet Explorer の [OneNote に送る] をクリックした結果としてのノートなど) を、このフォルダーに保存します。

ページ コンテンツのメソッド

このセクションで説明するメソッドを使用すると、OneNote ノートブックのページにあるコンテンツを探索、更新、および削除できます。また、OneNote コンテンツを発行することもできます。

GetPageContent メソッド

既定では、過度に長い XML 文字列を返さないようにするために、OneNote は XML コードにバイナリ コンテンツを埋め込みません。 同じ理由から、現在の選択部分を選択属性でマーク アップすることもありません。 バイナリ オブジェクトは、そのオブジェクトのタグに OneNote ID が含まれています。 バイナリ オブジェクトを取得するには、GetBinaryPageContent メソッドを呼び出して、GetPageContent メソッドから取得した OneNote ID を渡します。 GetPageContent メソッドは、その時点でバイナリ データが不要なときに使用します。

UpdatePageContent メソッド

このメソッドを使用すると、さまざまな方法でページを変更できます。 たとえば、UpdatePageContent メソッドは、ページへのアウトアインの追加、アウトラインのコンテンツの変更、イメージの追加、インクの追加、コンテンツの移動、アウトラインのテキストの変更などに使用できます。

具体的な例としては、GetPageContent メソッドを使用して既存のページをエクスポートし、ページの XML コードに変更を加えてから、UpdatePageContent メソッドを使用してページ全体を再度インポートします。 また、このメソッドを使用して、新しいページ オブジェクト (イメージなど) を既存のページの下部に追加することもできます。

UpdatePageContent メソッドに渡す XML コードには、変更したページ レベルのオブジェクト (アウトライン、ページ上のイメージ、ページ上のインクなど) のみを含める必要があります。 このメソッドは、bstrPageChangesXmlIn パラメーターで指定していないページ レベルのオブジェクトを変更または削除することはありません。 このメソッドは、渡されたオブジェクトの ID と一致する ID を持つページ レベルのオブジェクト (アウトラインなど) を完全に置き換えます。 そのため、コードでは、既存のコンテンツとそのコンテンツに加える変更内容を含めて、すべてのページ レベルのオブジェクトを完全に指定する必要があります。

たとえば、ページにアウトラインと背景ページ イメージが含まれている場合は、XML コードで既存のアウトラインの ID を使用してアウトラインを完全に指定して、そのコードにイメージを含めないようにすることで、イメージを変更することなく、アウトラインを置き換えることができます。 既存のアウトラインはコードに含まれる改訂したアウトラインで完全に置き換えられるため、そのアウトラインのすべてのコンテンツを含める必要があります。

さらに、UpdatePageContent メソッドは、bstrPageChangesXmlIn パラメーターで指定した要素のプロパティのみを変更します。 たとえば、PageSettings 要素のすべてのプロパティではなく、一部のプロパティを指定すると、指定していないプロパティは変更されません。

次の例は、UpdatePageContent メソッドを使用して、ページのタイトルを変更し、そのページにいくつかのサンプル テキストを追加する方法を示しています。 このコードの実行前に、自分のコンピューターでコードが動作するように、コード内に示したページ ID を有効なページ ID に置換してください。 ページのページ ID は、GetHierarchy メソッドを使用して出力を調べることでわかります。

static void UpdatePageContent()
    {
        OneNote.Application onApplication = new OneNote.Application();
        String strImportXML;
        strImportXML = "<?xml version=\"1.0\"?>" +
            "<one:Page xmlns:one=\"http://schemas.microsoft.com/office/onenote/12/2004/onenote\" 
            ID=\"{3428B7BB-EF39-4B9C-A167-3FAE20630C37}{1}{B0}\">" +
            "    <one:PageSettings RTL=\"false\" color=\"automatic\">" +
            "        <one:PageSize>" +
            "            <one:Automatic/>" +
            "        </one:PageSize>" +
            "        <one:RuleLines visible=\"false\"/>" +
            "    </one:PageSettings>" +
            "    <one:Title style=\"font-family:Calibri;
                 font-size:17.0pt\" lang=\"en-US\">" +
            "        <one:OE alignment=\"left\">" +
            "            <one:T>" +
            "                <![CDATA[My Sample Page]]>" +
            "            </one:T>" +
            "        </one:OE>" +
            "    </one:Title>" +
            "    <one:Outline >" +
            "        <one:Position x=\"120\" y=\"160\"/>" +
            "        <one:Size width=\"120\" height=\"15\"/>" +
            "        <one:OEChildren>" +
            "            <one:OE alignment=\"left\">" +
            "                <one:T>" +
            "                    <![CDATA[Sample Text]]>" +
            "                </one:T>" +
            "            </one:OE>" +
            "        </one:OEChildren>" +
            "    </one:Outline>" +
            "</one:Page>";
        // Update the page content.
        onApplication.UpdatePageContent(strImportXML, System.DateTime.MinValue);
    }

GetBinaryPageContent メソッド

DeletePageContent メソッド

Publish メソッド

現在、OneNote では次のファイル形式をサポートしています。

• MHTML ファイル (.mht)
• Adobe Acrobat PDF ファイル (.pdf)
• XML Paper Specification (XPS) ファイル (.xps)
• OneNote 2013、2010 または 2007 ファイル (.one)
• OneNote パッケージ ファイル (.onepkg)
• Microsoft Word 文書 (.doc or .docx)
• Microsoft Windows 拡張メタファイル (.emf)
• HTML ファイル (.html)

このメソッドは、UI の [発行] をクリックして形式を指定した場合と、まったく同じ結果を生成します。

ナビゲーションのメソッド

このセクションで説明するメソッドを使用すると、OneNote ノートブック、セクション グループ、セクション、ページ、およびページ オブジェクトへのナビゲーション、リンク、および検索が可能になります。

NavigateTo メソッド

NavigateToUrl メソッド

GetHyperLinkToObject メソッド

結果のリンク先にナビゲートしようとすると、OneNote は指定のオブジェクトをブラウザーで開いて表示します。

GetWebHyperlinktoObject メソッド

FindPages メソッド

FindPages は、コンピューターに Microsoft Search 3.0 または 4.0 がインストールされている場合にのみ動作します。 Windows Vista および Windows 7 には、このコンポーネントが組み込まれています。 ただし、それより前のバージョンの Windows を実行している場合は、FindPages が動作するように、Windows Search をインストールする必要があります。

FindMeta メソッド

FindMeta は、コンピューターに Microsoft Windows Search 3.0 または 4.0 がインストールされている場合にのみ動作します。 Windows Vista および Windows 7 には、このコンポーネントが組み込まれています。 ただし、それより前のバージョンの Windows を実行している場合は、FindMeta が動作するように、Windows Search をインストールする必要があります。

機能性のメソッド

このセクションで説明するメソッドを使用すると、OneNote アプリケーションで特定のアクションを実行することやパラメーターを設定することができます。

MergeFiles メソッド

MergeFiles メソッドは、複数バージョンの OneNote ファイルが存在する可能性のあるモバイル シナリオに向けられたものです。

MergeSections メソッド

このメソッドは、セクションを右クリックしたときに表示される [別のセクションに結合] 機能と同じ操作を実行します。

QuickFiling メソッド

SyncHierarchy メソッド

SetFilingLocation メソッド

分類整理できるコンテンツの種類には、Outlook アイテムおよび Internet Explorer からの Web ノートが含まれます。これらは、それぞれのアプリケーションの [OneNote に送る] コマンドで OneNote にインポートします。 OneNote に出力するアイテムをファイリングする場所は、このメソッドで設定することもできます。

プロパティ

このセクションでは、Application インターフェイスのプロパティについて説明します。

イベント

このセクションでは、Application インターフェイスのイベントについて説明します。

OnNavigate イベント

OnHierarchyChange メソッド

関連項目

• OneNote 開発者用リファレンス