OneNote.InkWord class

Пакет:

onenote

Контейнер для рукописного фрагмента в слове абзаца.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Получает идентификатор объекта InkWord. Только для чтения.
languageId	Идентификатор распознанного языка в этом слове рукописного фрагмента. Только для чтения.
paragraph	Родительский абзац, содержащий слово рукописного фрагмента. Только для чтения.
wordAlternates	Слова, которые были распознаны в этом слове рукописного фрагмента, в порядке вероятности. Только для чтения.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект OneNote.InkWord является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.InkWordData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если этот объект используется в .sync вызовах и вне последовательного выполнения пакета .run, и при установке свойства или вызове метода для объекта возникает ошибка InvalidObjectPath, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

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

context

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

context: RequestContext;

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

OneNote.RequestContext

id

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

readonly id: string;

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

string

Комментарии

[ Набор API: OneNoteApi 1.1 ]

languageId

Идентификатор распознанного языка в этом слове рукописного фрагмента. Только для чтения.

readonly languageId: string;

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

string

Комментарии

[ Набор API: OneNoteApi 1.1 ]

paragraph

Родительский абзац, содержащий слово рукописного фрагмента. Только для чтения.

readonly paragraph: OneNote.Paragraph;

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

OneNote.Paragraph

Комментарии

[ Набор API: OneNoteApi 1.1 ]

wordAlternates

Слова, которые были распознаны в этом слове рукописного фрагмента, в порядке вероятности. Только для чтения.

readonly wordAlternates: string[];

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

string[]

Комментарии

[ Набор API: OneNoteApi 1.1 ]

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

load(options)

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

load(options?: OneNote.Interfaces.InkWordLoadOptions): OneNote.InkWord;

Параметры

options

OneNote.Interfaces.InkWordLoadOptions

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

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

OneNote.InkWord

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

OneNote.InkWord

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

OneNote.InkWord

toJSON()

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

toJSON(): OneNote.Interfaces.InkWordData;

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

OneNote.Interfaces.InkWordData

track()

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

track(): OneNote.InkWord;

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

OneNote.InkWord

untrack()

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

untrack(): OneNote.InkWord;

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

OneNote.InkWord