OneNote.InkAnalysisWord class

Пакет:

onenote

Представляет данные анализа рукописного фрагмента для определенного слова, созданного росчерками пера.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Свойства

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

Методы

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

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

context

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

context: RequestContext;

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

OneNote.RequestContext

id

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

readonly id: string;

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

string

Комментарии

[ Набор API: OneNoteApi 1.1 ]

languageId

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

readonly languageId: string;

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

string

Комментарии

[ Набор API: OneNoteApi 1.1 ]

line

Ссылка на родительский объект InkAnalysisLine. Только для чтения.

readonly line: OneNote.InkAnalysisLine;

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

OneNote.InkAnalysisLine

Комментарии

[ Набор API: OneNoteApi 1.1 ]

strokePointers

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

readonly strokePointers: OneNote.InkStrokePointer[];

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

OneNote.InkStrokePointer[]

Комментарии

[ Набор API: OneNoteApi 1.1 ]

wordAlternates

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

readonly wordAlternates: string[];

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

string[]

Комментарии

[ Набор API: OneNoteApi 1.1 ]

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

load(options)

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

load(options?: OneNote.Interfaces.InkAnalysisWordLoadOptions): OneNote.InkAnalysisWord;

Параметры

options

OneNote.Interfaces.InkAnalysisWordLoadOptions

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

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

OneNote.InkAnalysisWord

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

OneNote.InkAnalysisWord

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

OneNote.InkAnalysisWord

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

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

Параметры

properties

OneNote.Interfaces.InkAnalysisWordUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: OneNote.InkAnalysisWord): void;

Параметры

properties

OneNote.InkAnalysisWord

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

void

toJSON()

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

toJSON(): OneNote.Interfaces.InkAnalysisWordData;

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

OneNote.Interfaces.InkAnalysisWordData

track()

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

track(): OneNote.InkAnalysisWord;

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

OneNote.InkAnalysisWord

untrack()

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

untrack(): OneNote.InkAnalysisWord;

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

OneNote.InkAnalysisWord