OneNote.Application class

Ссылка

Пакет:: onenote

Представляет собой объект верхнего уровня и содержит все глобально адресуемые объекты OneNote, например записные книжки, активную записную книжку и активный раздел.

Extends: OfficeExtension.ClientObject

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
notebooks	Получает коллекцию записных книжек, открытых в экземпляре приложения OneNote. В OneNote Online в экземпляре приложения может быть открыто не более одной записной книжки одновременно. Только для чтения.

Методы

getActiveNotebook()	Получает активную записную книжку, если она есть. Если такой записной книжки нет, создается исключение ItemNotFound.
getActiveNotebookOrNull()	Получает активную записную книжку, если она есть. Если такой записной книжки нет, возвращается значение null.
getActiveOutline()	Возвращает активную структуру, если она есть. Если такой структуры нет, создается исключение ItemNotFound.
getActiveOutlineOrNull()	Возвращает активную структуру, если она есть. Если такой нет, возвращается значение null.
getActivePage()	Возвращает активную страницу, если она есть. Если такой страницы нет, создается исключение ItemNotFound.
getActivePageOrNull()	Возвращает активную страницу, если она есть. Если активной страницы нет, возвращается значение null.
getActiveParagraph()	Возвращает активный абзац, если он существует. Если абзац не активен, вызывает метод ItemNotFound.
getActiveParagraphOrNull()	Возвращает активный абзац, если он существует, в противном случае возвращает значение NULL.
getActiveSection()	Возвращает активный раздел, если он есть. Если такого раздела нет, создается исключение ItemNotFound.
getActiveSectionOrNull()	Возвращает активный раздел, если он есть. Если такого раздела нет, возвращается значение null.
getSelectedInkStrokes()	Возвращает выбранные в настоящее время росчерки рукописного ввода.
getWindowSize()
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()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный объект OneNote.Application является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `OneNote.Interfaces.ApplicationData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

OneNote.RequestContext

notebooks

Получает коллекцию записных книжек, открытых в экземпляре приложения OneNote. В OneNote Online в экземпляре приложения может быть открыто не более одной записной книжки одновременно. Только для чтения.

readonly notebooks: OneNote.NotebookCollection;

Значение свойства

OneNote.NotebookCollection

Сведения о методе

getActiveNotebook()

Получает активную записную книжку, если она есть. Если такой записной книжки нет, создается исключение ItemNotFound.

getActiveNotebook(): OneNote.Notebook;

Возвращаемое значение

OneNote.Notebook

Примеры

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

Примеры

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

Примеры

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

Примеры

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

Примеры

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

Примеры

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()

Возвращает активный абзац, если он существует. Если абзац не активен, вызывает метод ItemNotFound.

getActiveParagraph(): OneNote.Paragraph;

Возвращаемое значение

OneNote.Paragraph

getActiveParagraphOrNull()

Возвращает активный абзац, если он существует, в противном случае возвращает значение NULL.

getActiveParagraphOrNull(): OneNote.Paragraph;

Возвращаемое значение

OneNote.Paragraph

getActiveSection()

Возвращает активный раздел, если он есть. Если такого раздела нет, создается исключение ItemNotFound.

getActiveSection(): OneNote.Section;

Возвращаемое значение

OneNote.Section

Примеры

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

Примеры

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);
    }
});

getSelectedInkStrokes()

Возвращает выбранные в настоящее время росчерки рукописного ввода.

getSelectedInkStrokes(): OneNote.InkStrokeCollection;

Возвращаемое значение

OneNote.InkStrokeCollection

getWindowSize()

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

Возвращаемое значение

OfficeExtension.ClientResult<number[]>

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

Примеры

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

Примеры

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

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: OneNote.Application): void;

Параметры

properties: OneNote.Application

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (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()

Возвращаемое значение

Комментарии

Примеры

getSelectedInkStrokes()

Возвращаемое значение

Комментарии

getWindowSize()

Возвращаемое значение

insertHtmlAtCurrentPosition(html)

Параметры

Возвращаемое значение

isViewingDeletedNotes()

Возвращаемое значение

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

navigateToPage(page)

Параметры

Возвращаемое значение

Комментарии

Примеры

navigateToPageWithClientUrl(url)

Параметры

Возвращаемое значение

Комментарии

Примеры

set(properties, options)