Word.Comment class

Pacote:

word

Representa um comentário no documento.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApi 1.4 ]

Propriedades

authorEmail	Obtém o email do autor do comentário.
authorName	Obtém o nome do autor do comentário.
content	Especifica o conteúdo do comentário como texto simples.
contentRange	Especifica o intervalo de conteúdo do comentário.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
creationDate	Obtém a data de criação do comentário.
id	Obtém a ID do comentário.
replies	Obtém a coleção de objetos de resposta associados ao comentário.
resolved	Especifica o status do thread de comentário. A configuração para true resolve o thread de comentários. Obter um valor de true significa que o thread de comentário foi resolvido.

Métodos

delete()	Exclui o comentário e suas respostas.
getRange()	Obtém o intervalo no documento main em que o comentário está.
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.
reply(replyText)	Adiciona uma nova resposta ao final do thread de comentários.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
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 Comment é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.CommentData) que contém cópias rasas de todas as 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

authorEmail

Obtém o email do autor do comentário.

readonly authorEmail: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.4 ]

authorName

Obtém o nome do autor do comentário.

readonly authorName: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.4 ]

content

Especifica o conteúdo do comentário como texto simples.

content: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.4 ]

Exemplos

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

// Edits the first comment in the selected content.
await Word.run(async (context) => {
  const text = $("#edit-comment-text")
    .val()
    .toString();
  const comment = context.document
    .getSelection()
    .getComments()
    .getFirst();
  comment.content = text;

  // Load object to log in the console.
  comment.load();
  await context.sync();

  console.log("Comment content changed:", comment);
});

contentRange

Especifica o intervalo de conteúdo do comentário.

contentRange: Word.CommentContentRange;

Valor da propriedade

Word.CommentContentRange

Comentários

[ Conjunto de API: WordApi 1.4 ]

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

creationDate

Obtém a data de criação do comentário.

readonly creationDate: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: WordApi 1.4 ]

id

Obtém a ID do comentário.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.4 ]

replies

Obtém a coleção de objetos de resposta associados ao comentário.

readonly replies: Word.CommentReplyCollection;

Valor da propriedade

Word.CommentReplyCollection

Comentários

[ Conjunto de API: WordApi 1.4 ]

resolved

Especifica o status do thread de comentário. A configuração para true resolve o thread de comentários. Obter um valor de true significa que o thread de comentário foi resolvido.

resolved: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.4 ]

Exemplos

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

// Toggles Resolved status of the first comment in the selected content.
await Word.run(async (context) => {
  const comment = context.document
    .getSelection()
    .getComments()
    .getFirst();
  comment.load("resolved");
  await context.sync();

  // Toggle resolved status.
  // If the comment is active, set as resolved.
  // If it's resolved, set resolved to false.
  const resolvedBefore = comment.resolved;
  comment.resolved = !resolvedBefore;
  comment.load();
  await context.sync();

  console.log(`Comment Resolved status: ${comment.resolved}`, comment);
});

Detalhes do método

delete()

Exclui o comentário e suas respostas.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.4 ]

Exemplos

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

// Deletes the first comment in the selected content.
await Word.run(async (context) => {
  context.document
    .getSelection()
    .getComments()
    .getFirst()
    .delete();
  await context.sync();

  console.log("Comment deleted");
});

getRange()

Obtém o intervalo no documento main em que o comentário está.

getRange(): Word.Range;

Retornos

Word.Range

Comentários

[ Conjunto de API: WordApi 1.4 ]

Exemplos

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

// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
  const range = context.document
    .getSelection()
    .getComments()
    .getFirst()
    .getRange();
  range.load("text");
  await context.sync();

  console.log(`Comment location: ${range.text}`);
});

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.CommentLoadOptions): Word.Comment;

Parâmetros

options

Word.Interfaces.CommentLoadOptions

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

Retornos

Word.Comment

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.Comment;

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.Comment

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.Comment;

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.Comment

reply(replyText)

Adiciona uma nova resposta ao final do thread de comentários.

reply(replyText: string): Word.CommentReply;

Parâmetros

replyText

string

Obrigatório. Responder texto.

Retornos

Word.CommentReply

Comentários

[ Conjunto de API: WordApi 1.4 ]

Exemplos

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

// Replies to the first active comment in the selected content.
await Word.run(async (context) => {
  const text = $("#reply-text")
    .val()
    .toString();
  const comments = context.document.getSelection().getComments();
  comments.load("items");
  await context.sync();

  const firstActiveComment = comments.items.find((item) => item.resolved !== true);
  if (firstActiveComment) {
    const reply = firstActiveComment.reply(text);
    console.log("Reply added");
  } else {
    console.log("No active comment was found in the selection so couldn't reply.");
  }
});

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties

Word.Interfaces.CommentUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.Comment): void;

Parâmetros

properties

Word.Comment

Retornos

void

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 Comment é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.CommentData) que contém cópias rasas de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.CommentData;

Retornos

Word.Interfaces.CommentData

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.Comment;

Retornos

Word.Comment

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.Comment;

Retornos

Word.Comment