OneNote.Application class

リファレンス

パッケージ:: onenote

グローバルにアドレス可能な OneNote オブジェクト (ノートブック、アクティブなノートブック、アクティブなセクションなど) すべてを含む最上位のオブジェクトを表します。

Extends: OfficeExtension.ClientObject

注釈

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
notebooks	OneNote アプリケーションインスタンスで開いているノートブックのコレクションを取得します。 OneNote Online では、ノートブックはアプリケーションインスタンスで一度に 1 つだけ開かれます。読み取り専用です。

メソッド

getActiveNotebook()	存在する場合はアクティブなノートブックを取得します。アクティブなノートブックがない場合は、ItemNotFound をスローします。
getActiveNotebookOrNull()	存在する場合はアクティブなノートブックを取得します。アクティブなノートブックがない場合は、null を返します。
getActiveOutline()	存在する場合はアクティブなアウトラインを取得します。アクティブなアウトラインがない場合は、ItemNotFound をスローします。
getActiveOutlineOrNull()	存在する場合はアクティブなアウトラインを取得します。アクティブなアウトラインがない場合は、null を返します。
getActivePage()	存在する場合はアクティブなページを取得します。アクティブなページがない場合は、ItemNotFound をスローします。
getActivePageOrNull()	存在する場合はアクティブなページを取得します。アクティブなページがない場合は、null を返します。
getActiveParagraph()	アクティブな Paragraph が存在する場合は取得し、アクティブな段落がない場合は ItemNotFound をスローします。
getActiveParagraphOrNull()	アクティブな Paragraph が存在する場合は取得し、それ以外の場合は null を返します。
getActiveSection()	存在する場合はアクティブなセクションを取得します。アクティブなセクションがない場合は、ItemNotFound をスローします。
getActiveSectionOrNull()	存在する場合はアクティブなセクションを取得します。アクティブなセクションがない場合は、null を返します。
getDecimalSeparator()
getSelectedInkStrokes()	現在選択されているインクストロークを取得します。
getWindowSize()
insertAndEmbedLinkAtCurrentPosition(url)
insertHtmlAtCurrentPosition(html)
isViewingDeletedNotes()
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
navigateToPage(page)	アプリケーションインスタンスで指定されたページを開きます。
navigateToPageWithClientUrl(url)	指定されたページを取得し、アプリケーションインスタンスで開きます。失敗しない場合でも、ナビゲーションが実行されない場合があります。必要に応じて、呼び出し元が返されたページを検証する必要があります。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()	API オブジェクトが`JSON.stringify()`に渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (`JSON.stringify`、それに渡されるオブジェクトの `toJSON` メソッドを呼び出します)。元の `OneNote.Application` オブジェクトは API オブジェクトですが、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `OneNote.Interfaces.ApplicationData` として型指定) を返します。

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

OneNote.RequestContext

notebooks

OneNote アプリケーションインスタンスで開いているノートブックのコレクションを取得します。 OneNote Online では、ノートブックはアプリケーションインスタンスで一度に 1 つだけ開かれます。読み取り専用です。

readonly notebooks: OneNote.NotebookCollection;

プロパティ値

OneNote.NotebookCollection

注釈

[ API セット: OneNoteApi 1.1 ]

メソッドの詳細

getActiveNotebook()

存在する場合はアクティブなノートブックを取得します。アクティブなノートブックがない場合は、ItemNotFound をスローします。

getActiveNotebook(): OneNote.Notebook;

戻り値

OneNote.Notebook

注釈

[ API セット: OneNoteApi 1.1 ]

例

await OneNote.run(async (context) => {
        
    // Get the active notebook.
    const notebook = context.application.getActiveNotebook();
            
    // Queue a command to load the notebook.
    // For best performance, request specific properties.
    notebook.load('id,name');
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
                    
    // Show some properties.
    console.log("Notebook name: " + notebook.name);
    console.log("Notebook ID: " + notebook.id);
            
});

getActiveNotebookOrNull()

存在する場合はアクティブなノートブックを取得します。アクティブなノートブックがない場合は、null を返します。

getActiveNotebookOrNull(): OneNote.Notebook;

戻り値

OneNote.Notebook

注釈

[ API セット: OneNoteApi 1.1 ]

例

await OneNote.run(async (context) => {

    // Get the active notebook.
    const notebook = context.application.getActiveNotebookOrNull();

    // Queue a command to load the notebook.
    // For best performance, request specific properties.
    notebook.load('id,name');

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    // Check if active notebook is set.
    if (!notebook.isNullObject) {
        console.log("Notebook name: " + notebook.name);
        console.log("Notebook ID: " + notebook.id);
    }
});

getActiveOutline()

存在する場合はアクティブなアウトラインを取得します。アクティブなアウトラインがない場合は、ItemNotFound をスローします。

getActiveOutline(): OneNote.Outline;

戻り値

OneNote.Outline

注釈

[ API セット: OneNoteApi 1.1 ]

例

await OneNote.run(async (context) => {

    // get active outline.
    const outline = context.application.getActiveOutline();

    // Queue a command to load the id of the outline.
    outline.load('id');

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    // Show some properties.
    console.log("outline id: " + outline.id);
});

getActiveOutlineOrNull()

存在する場合はアクティブなアウトラインを取得します。アクティブなアウトラインがない場合は、null を返します。

getActiveOutlineOrNull(): OneNote.Outline;

戻り値

OneNote.Outline

注釈

[ API セット: OneNoteApi 1.1 ]

例

await OneNote.run(async (context) => {

    // get active outline.
    const outline = context.application.getActiveOutlineOrNull();

    // Queue a command to load the id of the outline.
    outline.load('id');

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (!outline.isNullObject) {
        console.log("outline id: " + outline.id);
    }
});

getActivePage()

存在する場合はアクティブなページを取得します。アクティブなページがない場合は、ItemNotFound をスローします。

getActivePage(): OneNote.Page;

戻り値

OneNote.Page

注釈

[ API セット: OneNoteApi 1.1 ]

例

await OneNote.run(async (context) => {
        
    // Get the active page.
    const page = context.application.getActivePage();
            
    // Queue a command to load the page.
    // For best performance, request specific properties.
    page.load('id,title');
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
                    
    // Show some properties.
    console.log("Page title: " + page.title);
    console.log("Page ID: " + page.id);
});

getActivePageOrNull()

存在する場合はアクティブなページを取得します。アクティブなページがない場合は、null を返します。

getActivePageOrNull(): OneNote.Page;

戻り値

OneNote.Page

注釈

[ API セット: OneNoteApi 1.1 ]

例

await OneNote.run(async (context) => {

    // Get the active page.
    const page = context.application.getActivePageOrNull();

    // Queue a command to load the page.
    // For best performance, request specific properties.
    page.load('id,title');

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
            
    if (!page.isNullObject) {
        // Show some properties.
        console.log("Page title: " + page.title);
        console.log("Page ID: " + page.id);
    }
});

getActiveParagraph()

アクティブな Paragraph が存在する場合は取得し、アクティブな段落がない場合は ItemNotFound をスローします。

getActiveParagraph(): OneNote.Paragraph;

戻り値

OneNote.Paragraph

注釈

[ API セット: OneNoteApi 1.1 ]

getActiveParagraphOrNull()

アクティブな Paragraph が存在する場合は取得し、それ以外の場合は null を返します。

getActiveParagraphOrNull(): OneNote.Paragraph;

戻り値

OneNote.Paragraph

注釈

[ API セット: OneNoteApi 1.1 ]

getActiveSection()

存在する場合はアクティブなセクションを取得します。アクティブなセクションがない場合は、ItemNotFound をスローします。

getActiveSection(): OneNote.Section;

戻り値

OneNote.Section

注釈

[ API セット: OneNoteApi 1.1 ]

例

await OneNote.run(async (context) => {
        
    // Get the active section.
    const section = context.application.getActiveSection();
            
    // Queue a command to load the section.
    // For best performance, request specific properties.
    section.load('id,name');
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
                    
    // Show some properties.
    console.log("Section name: " + section.name);
    console.log("Section ID: " + section.id);
});

getActiveSectionOrNull()

存在する場合はアクティブなセクションを取得します。アクティブなセクションがない場合は、null を返します。

getActiveSectionOrNull(): OneNote.Section;

戻り値

OneNote.Section

注釈

[ API セット: OneNoteApi 1.1 ]

例

await OneNote.run(async (context) => {

    // Get the active section.
    const section = context.application.getActiveSectionOrNull();

    // Queue a command to load the section.
    // For best performance, request specific properties.
    section.load('id,name');

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (!section.isNullObject) {
        // Show some properties.
        console.log("Section name: " + section.name);
        console.log("Section ID: " + section.id);
    }
});

getDecimalSeparator()

getDecimalSeparator(): OfficeExtension.ClientResult<string>;

戻り値

OfficeExtension.ClientResult<string>

getSelectedInkStrokes()

現在選択されているインクストロークを取得します。

getSelectedInkStrokes(): OneNote.InkStrokeCollection;

戻り値

OneNote.InkStrokeCollection

注釈

[ API セット: OneNoteApi 1.9 ]

getWindowSize()

getWindowSize(): OfficeExtension.ClientResult<number[]>;

戻り値

OfficeExtension.ClientResult<number[]>

insertAndEmbedLinkAtCurrentPosition(url)

insertAndEmbedLinkAtCurrentPosition(url: string): void;

パラメーター

url: string

戻り値

void

insertHtmlAtCurrentPosition(html)

insertHtmlAtCurrentPosition(html: string): void;

パラメーター

html: string

戻り値

void

isViewingDeletedNotes()

isViewingDeletedNotes(): OfficeExtension.ClientResult<boolean>;

戻り値

OfficeExtension.ClientResult<boolean>

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: OneNote.Interfaces.ApplicationLoadOptions): OneNote.Application;

パラメーター

options: OneNote.Interfaces.ApplicationLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

OneNote.Application

load(propertyNames)

load(propertyNames?: string | string[]): OneNote.Application;

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

OneNote.Application

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.Application;

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

OneNote.Application

navigateToPage(page)

アプリケーションインスタンスで指定されたページを開きます。

navigateToPage(page: OneNote.Page): void;

パラメーター

page: OneNote.Page

開くページです。

戻り値

void

注釈

[ API セット: OneNoteApi 1.1 ]

例

await OneNote.run(async (context) => {
        
    // Get the pages in the current section.
    const pages = context.application.getActiveSection().pages;
            
    // Queue a command to load the pages.
    // For best performance, request specific properties.
    pages.load('id');
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync()
                    
    // This example loads the first page in the section.
    const page = pages.items[0];
                
    // Open the page in the application.
    context.application.navigateToPage(page);
            
    // Run the queued command.
    await context.sync();
});

navigateToPageWithClientUrl(url)

指定されたページを取得し、アプリケーションインスタンスで開きます。失敗しない場合でも、ナビゲーションが実行されない場合があります。必要に応じて、呼び出し元が返されたページを検証する必要があります。

navigateToPageWithClientUrl(url: string): OneNote.Page;

パラメーター

url: string

開くページのクライアント URL です。

戻り値

OneNote.Page

注釈

[ API セット: OneNoteApi 1.1 ]

例

await OneNote.run(async (context) => {

    // Get the pages in the current section.
    const pages = context.application.getActiveSection().pages;

    // Queue a command to load the pages.
    // For best performance, request specific properties.
    pages.load('clientUrl');

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync()

    // This example loads the first page in the section.
    const page = pages.items[0];

    // Open the page in the application.
    context.application.navigateToPageWithClientUrl(page.clientUrl);

    // Run the queued command.
    await context.sync();
});

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties: OneNote.Interfaces.ApplicationUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: OneNote.Application): void;

パラメーター

properties: OneNote.Application

戻り値

void

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の OneNote.Application オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( OneNote.Interfaces.ApplicationData として型指定) を返します。

toJSON(): OneNote.Interfaces.ApplicationData;

戻り値

OneNote.Interfaces.ApplicationData

次の方法で共有

OneNote.Application class

注釈

プロパティ

メソッド

プロパティの詳細

context

プロパティ値

notebooks

プロパティ値

注釈

メソッドの詳細

getActiveNotebook()

戻り値

注釈

例

getActiveNotebookOrNull()

戻り値

注釈

例

getActiveOutline()

戻り値

注釈

例

getActiveOutlineOrNull()

戻り値

注釈

例

getActivePage()

戻り値

注釈

例

getActivePageOrNull()

戻り値

注釈

例

getActiveParagraph()

戻り値

注釈

getActiveParagraphOrNull()

戻り値

注釈

getActiveSection()

戻り値

注釈

例

getActiveSectionOrNull()

戻り値

注釈

例

getDecimalSeparator()

戻り値

getSelectedInkStrokes()

戻り値

注釈

getWindowSize()

戻り値

insertAndEmbedLinkAtCurrentPosition(url)

パラメーター

戻り値

insertHtmlAtCurrentPosition(html)

パラメーター

戻り値

isViewingDeletedNotes()

戻り値

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

load(propertyNamesAndPaths)

パラメーター

戻り値

navigateToPage(page)

パラメーター

戻り値

注釈

例

navigateToPageWithClientUrl(url)