OneNote.InkAnalysisWord class

Paquete:

onenote

Representa los datos de análisis de tinta para una palabra identificada formada por trazos de tinta.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
id	Obtiene el identificador del objeto InkAnalysisWord. Solo lectura.
languageId	El identificador del idioma reconocido en esta inkAnalysisWord. Solo lectura.
line	Referencia a la InkAnalysisLine principal. Solo lectura.
strokePointers	Referencias débiles a los trazos de tinta que se han reconocido como parte de esta palabra de análisis de tinta. Solo lectura.
wordAlternates	Las palabras que se han reconocido en esta palabra de tinta, por orden de probabilidad. Solo lectura.

Métodos

load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
set(properties, options)	Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
toJSON()	Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto OneNote.InkAnalysisWord original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.InkAnalysisWordData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
track()	Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe haber agregado el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.
untrack()	Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

OneNote.RequestContext

id

Obtiene el identificador del objeto InkAnalysisWord. Solo lectura.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

languageId

El identificador del idioma reconocido en esta inkAnalysisWord. Solo lectura.

readonly languageId: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

line

Referencia a la InkAnalysisLine principal. Solo lectura.

readonly line: OneNote.InkAnalysisLine;

Valor de propiedad

OneNote.InkAnalysisLine

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

strokePointers

Referencias débiles a los trazos de tinta que se han reconocido como parte de esta palabra de análisis de tinta. Solo lectura.

readonly strokePointers: OneNote.InkStrokePointer[];

Valor de propiedad

OneNote.InkStrokePointer[]

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

wordAlternates

Las palabras que se han reconocido en esta palabra de tinta, por orden de probabilidad. Solo lectura.

readonly wordAlternates: string[];

Valor de propiedad

string[]

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Detalles del método

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

options

OneNote.Interfaces.InkAnalysisWordLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

OneNote.InkAnalysisWord

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

OneNote.InkAnalysisWord

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

OneNote.InkAnalysisWord

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

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

Parámetros

properties

OneNote.Interfaces.InkAnalysisWordUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options

OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: OneNote.InkAnalysisWord): void;

Parámetros

properties

OneNote.InkAnalysisWord

Devoluciones

void

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto OneNote.InkAnalysisWord original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.InkAnalysisWordData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): OneNote.Interfaces.InkAnalysisWordData;

Devoluciones

OneNote.Interfaces.InkAnalysisWordData

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe haber agregado el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.

track(): OneNote.InkAnalysisWord;

Devoluciones

OneNote.InkAnalysisWord

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): OneNote.InkAnalysisWord;

Devoluciones

OneNote.InkAnalysisWord