Word.Annotation class

  • Referência
Pacote:
word

Representa uma anotação anexada a um parágrafo.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApi 1.7 ]

Propriedades

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
critiqueAnnotation

Obtém o objeto de anotação de crítica.
id

Obtém o identificador exclusivo, que deve ser usado para facilitar o rastreamento de objetos de anotação.
state

Obtém o estado da anotação.

Métodos

delete()

Exclui a anotação.
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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. Objeto de anotação é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.AnnotationData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse 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, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.
untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar context.sync() antes que a versão da memória entre em vigor.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

critiqueAnnotation

Obtém o objeto de anotação de crítica.

readonly critiqueAnnotation: Word.CritiqueAnnotation;

Valor da propriedade

Word.CritiqueAnnotation

Comentários

[ Conjunto de API: WordApi 1.7 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Gets annotations found in the selected paragraph.
await Word.run(async (context) => {
  const paragraph = context.document.getSelection().paragraphs.getFirst();
  const annotations = paragraph.getAnnotations();
  annotations.load("id,state,critiqueAnnotation");

  await context.sync();

  console.log("Annotations found:");

  for (var i = 0; i < annotations.items.length; i++) {
    const annotation = annotations.items[i];

    console.log(`${annotation.id} - ${annotation.state} - ${JSON.stringify(annotation.critiqueAnnotation.critique)}`);
  }
});

id

Obtém o identificador exclusivo, que deve ser usado para facilitar o rastreamento de objetos de anotação.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.7 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Accepts the first annotation found in the selected paragraph.
await Word.run(async (context) => {
  const paragraph = context.document.getSelection().paragraphs.getFirst();
  const annotations = paragraph.getAnnotations();
  annotations.load("id,state,critiqueAnnotation");

  await context.sync();

  for (var i = 0; i < annotations.items.length; i++) {
    const annotation = annotations.items[i];

    if (annotation.state === Word.AnnotationState.created) {
      console.log(`Accepting ${annotation.id}`);
      annotation.critiqueAnnotation.accept();

      await context.sync();
      break;
    }
  }
});

state

Obtém o estado da anotação.

readonly state: Word.AnnotationState | "Created" | "Accepted" | "Rejected";

Valor da propriedade

Word.AnnotationState | "Created" | "Accepted" | "Rejected"

Comentários

[ Conjunto de API: WordApi 1.7 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Rejects the last annotation found in the selected paragraph.
await Word.run(async (context) => {
  const paragraph = context.document.getSelection().paragraphs.getFirst();
  const annotations = paragraph.getAnnotations();
  annotations.load("id,state,critiqueAnnotation");

  await context.sync();

  for (var i = annotations.items.length - 1; i >= 0; i--) {
    const annotation = annotations.items[i];

    if (annotation.state === Word.AnnotationState.created) {
      console.log(`Rejecting ${annotation.id}`);
      annotation.critiqueAnnotation.reject();

      await context.sync();
      break;
    }
  }
});

Detalhes do método

delete()

Exclui a anotação.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.7 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Deletes all annotations found in the selected paragraph.
await Word.run(async (context) => {
  const paragraph = context.document.getSelection().paragraphs.getFirst();
  const annotations = paragraph.getAnnotations();
  annotations.load("id");

  await context.sync();

  const ids = [];
  for (var i = 0; i < annotations.items.length; i++) {
    const annotation = annotations.items[i];

    ids.push(annotation.id);
    annotation.delete();
  }

  await context.sync();

  console.log("Annotations deleted:", ids);
});

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?: Word.Interfaces.AnnotationLoadOptions): Word.Annotation;

Parâmetros

options
Word.Interfaces.AnnotationLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Word.Annotation

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[]): Word.Annotation;

Parâmetros

propertyNames

string | string[]

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

Retornos

Word.Annotation

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;
        }): Word.Annotation;

Parâmetros

propertyNamesAndPaths

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

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

Retornos

Word.Annotation

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. Objeto de anotação é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.AnnotationData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.AnnotationData;

Retornos

Word.Interfaces.AnnotationData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse 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, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.Annotation;

Retornos

Word.Annotation

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar context.sync() antes que a versão da memória entre em vigor.

untrack(): Word.Annotation;

Retornos

Word.Annotation