Поделиться через

OneNote.FloatingInk class

  • Ссылка
Пакет:
onenote

Представляет группу росчерков пера.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Свойства

context

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

Получает идентификатор объекта FloatingInk. Только для чтения.
inkStrokes

Получает росчерки объекта FloatingInk. Только для чтения.
pageContent

Возвращает родительский объект PageContent для объекта FloatingInk. Только для чтения.

Методы

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект OneNote.FloatingInk является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.FloatingInkData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

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

context

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

context: RequestContext;

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

OneNote.RequestContext

id

Получает идентификатор объекта FloatingInk. Только для чтения.

readonly id: string;

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

string

Комментарии

[ Набор API: OneNoteApi 1.1 ]

inkStrokes

Получает росчерки объекта FloatingInk. Только для чтения.

readonly inkStrokes: OneNote.InkStrokeCollection;

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

OneNote.InkStrokeCollection

Комментарии

[ Набор API: OneNoteApi 1.1 ]

pageContent

Возвращает родительский объект PageContent для объекта FloatingInk. Только для чтения.

readonly pageContent: OneNote.PageContent;

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

OneNote.PageContent

Комментарии

[ Набор API: OneNoteApi 1.1 ]

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

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: OneNote.Interfaces.FloatingInkLoadOptions): OneNote.FloatingInk;

Параметры

options
OneNote.Interfaces.FloatingInkLoadOptions

Предоставляет параметры свойств загружаемого объекта.

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

OneNote.FloatingInk

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

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

OneNote.FloatingInk

Примеры

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

    // Gets the active page.
    const page = context.application.getActivePage();
    const contents = page.contents;
    
    // Load page contents and their types.
    page.load('contents/type');
    await context.sync();
        
    // Load every ink content.
    $.each(contents.items, function(i, content) {
        if (content.type == "Ink")
        {
            content.load('ink/id');
        }                            
    });
    await context.sync();
        
    // Log ID of every ink content.
    $.each(contents.items, function(i, content) {
        if (content.type == "Ink")
        {
            console.log(content.ink.id);
        }                            
    });           
});

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

OneNote.FloatingInk

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект OneNote.FloatingInk является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.FloatingInkData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): OneNote.Interfaces.FloatingInkData;

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

OneNote.Interfaces.FloatingInkData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.

track(): OneNote.FloatingInk;

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

OneNote.FloatingInk

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): OneNote.FloatingInk;

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

OneNote.FloatingInk