Compartilhar via


OneNote.InkWord class

Um contêiner para a tinta em uma palavra em um parágrafo.

Extends

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Propriedades

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

id

Obtém a ID do objeto InkWord.

languageId

O ID do idioma reconhecido nesta palavra a tinta digital.

paragraph

O parágrafo pai que contém a palavra de tinta.

wordAlternates

As palavras que foram reconhecidas na palavra tinta, em ordem de probabilidade.

Métodos

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original OneNote.InkWord é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.InkWordData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez.

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

Detalhes da propriedade

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

id

Obtém a ID do objeto InkWord.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

languageId

O ID do idioma reconhecido nesta palavra a tinta digital.

readonly languageId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

paragraph

O parágrafo pai que contém a palavra de tinta.

readonly paragraph: OneNote.Paragraph;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

wordAlternates

As palavras que foram reconhecidas na palavra tinta, em ordem de probabilidade.

readonly wordAlternates: string[];

Valor da propriedade

string[]

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Detalhes do método

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options
OneNote.Interfaces.InkWordLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original OneNote.InkWord é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.InkWordData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): OneNote.Interfaces.InkWordData;

Retornos

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez.

track(): OneNote.InkWord;

Retornos

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): OneNote.InkWord;

Retornos