Word.CommentReply class
Representa uma resposta de comentário no documento.
- Extends
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.");
}
});
Propriedades
author |
Obtém o email do autor da resposta do comentário. |
author |
Obtém o nome do autor da resposta do comentário. |
content | Especifica o conteúdo da resposta de comentário. A cadeia de caracteres é texto simples. |
content |
Especifica o intervalo de conteúdo do commentReply. |
context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
creation |
Obtém a data de criação da resposta de comentário. |
id | Obtém a ID da resposta de comentário. |
parent |
Obtém o comentário pai desta resposta. |
Métodos
delete() | Exclui a resposta do comentário. |
load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
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 |
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 |
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 |
Detalhes da propriedade
authorEmail
Obtém o email do autor da resposta do comentário.
readonly authorEmail: string;
Valor da propriedade
string
Comentários
authorName
Obtém o nome do autor da resposta do comentário.
readonly authorName: string;
Valor da propriedade
string
Comentários
content
Especifica o conteúdo da resposta de comentário. A cadeia de caracteres é texto simples.
content: string;
Valor da propriedade
string
Comentários
contentRange
Especifica o intervalo de conteúdo do commentReply.
contentRange: Word.CommentContentRange;
Valor da propriedade
Comentários
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
creationDate
Obtém a data de criação da resposta de comentário.
readonly creationDate: Date;
Valor da propriedade
Date
Comentários
id
Obtém a ID da resposta de comentário.
readonly id: string;
Valor da propriedade
string
Comentários
parentComment
Obtém o comentário pai desta resposta.
readonly parentComment: Word.Comment;
Valor da propriedade
Comentários
Detalhes do método
delete()
Exclui a resposta do comentário.
delete(): void;
Retornos
void
Comentários
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.CommentReplyLoadOptions): Word.CommentReply;
Parâmetros
Fornece opções para quais propriedades do objeto 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[]): Word.CommentReply;
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
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.CommentReply;
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
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.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Word.Interfaces.CommentReplyUpdateData
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.CommentReply): void;
Parâmetros
- properties
- Word.CommentReply
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.stringify
por sua vez, chama o toJSON
método do objeto que é passado para ele.) Enquanto o Word original. O objeto CommentReply é um objeto API, o toJSON
método retorna um objeto JavaScript simples (digitado como Word.Interfaces.CommentReplyData
) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Word.Interfaces.CommentReplyData;
Retornos
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.CommentReply;
Retornos
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.CommentReply;
Retornos
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de