Excel.Comment class
Representa um comentário na pasta de trabalho.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.10 ]
Propriedades
| author |
Obtém o email do autor do comentário. |
| author |
Obtém o nome do autor do comentário. |
| content | O conteúdo do comentário. A cadeia de caracteres é texto simples. |
| content |
Obtém o tipo 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. |
| creation |
Obtém o horário de criação do comentário. Retorna |
| id | Especifica o identificador de comentários. |
| mentions | Obtém as entidades (por exemplo, pessoas) que são mencionadas nos comentários. |
| replies | Representa uma coleção de objetos de resposta associados ao comentário. |
| resolved | O thread de comentários status. Um valor de |
| rich |
Obtém o conteúdo de comentários avançados (por exemplo, menções em comentários). Essa cadeia de caracteres não deve ser exibida para usuários finais. Seu suplemento só deve usá-lo para analisar conteúdo de comentários avançados. |
Métodos
| assign |
Atribui a tarefa anexada ao comentário ao usuário determinado como um atribuídor. Se não houver nenhuma tarefa, uma será criada. |
| delete() | Exclui o comentário e todas as respostas conectadas. |
| get |
Obtém a célula em que esse comentário está localizado. |
| get |
Obtém a tarefa associada a este comentário. Se não houver nenhuma tarefa para o thread de comentário, uma exceção |
| get |
Obtém a tarefa associada a este comentário. Se não houver nenhuma tarefa para o thread de comentário, esse método retornará um objeto com sua |
| 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 |
| update |
Atualizações o conteúdo do comentário com uma cadeia de caracteres especialmente formatada e uma lista de menções. |
Detalhes da propriedade
authorEmail
Obtém o email do autor do comentário.
readonly authorEmail: string;Valor da propriedade
string
Comentários
authorName
Obtém o nome do autor do comentário.
readonly authorName: string;Valor da propriedade
string
Comentários
content
O conteúdo do comentário. A cadeia de caracteres é texto simples.
content: string;Valor da propriedade
string
Comentários
[ Conjunto de API: ExcelApi 1.10 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
comment.content = "PLEASE add headers here.";
await context.sync();
});
contentType
Obtém o tipo de conteúdo do comentário.
readonly contentType: Excel.ContentType | "Plain" | "Mention";Valor da propriedade
Excel.ContentType | "Plain" | "Mention"
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 o horário de criação do comentário. Retorna null se o comentário foi convertido de uma nota, já que o comentário não tem uma data de criação.
readonly creationDate: Date;Valor da propriedade
Date
Comentários
id
Especifica o identificador de comentários.
readonly id: string;Valor da propriedade
string
Comentários
mentions
Obtém as entidades (por exemplo, pessoas) que são mencionadas nos comentários.
readonly mentions: Excel.CommentMention[];Valor da propriedade
Comentários
replies
Representa uma coleção de objetos de resposta associados ao comentário.
readonly replies: Excel.CommentReplyCollection;Valor da propriedade
Comentários
resolved
O thread de comentários status. Um valor de true significa que o thread de comentário foi resolvido.
resolved: boolean;Valor da propriedade
boolean
Comentários
[ Conjunto de API: ExcelApi 1.11 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-resolution.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Comments");
sheet.comments.getItemAt(0).resolved = true;
await context.sync();
});
richContent
Obtém o conteúdo de comentários avançados (por exemplo, menções em comentários). Essa cadeia de caracteres não deve ser exibida para usuários finais. Seu suplemento só deve usá-lo para analisar conteúdo de comentários avançados.
readonly richContent: string;Valor da propriedade
string
Comentários
Detalhes do método
assignTask(assignee)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Atribui a tarefa anexada ao comentário ao usuário determinado como um atribuídor. Se não houver nenhuma tarefa, uma será criada.
assignTask(assignee: Excel.EmailIdentity): Excel.DocumentTask;Parâmetros
- assignee
- Excel.EmailIdentity
As informações de identidade do usuário do atribuído.
Retornos
Comentários
delete()
Exclui o comentário e todas as respostas conectadas.
delete(): void;Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.10 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
await Excel.run(async (context) => {
context.workbook.comments.getItemByCell("Comments!A2").delete();
await context.sync();
});
getLocation()
Obtém a célula em que esse comentário está localizado.
getLocation(): Excel.Range;Retornos
Comentários
getTask()
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém a tarefa associada a este comentário. Se não houver nenhuma tarefa para o thread de comentário, uma exceção ItemNotFound será gerada.
getTask(): Excel.DocumentTask;Retornos
Comentários
getTaskOrNullObject()
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém a tarefa associada a este comentário. Se não houver nenhuma tarefa para o thread de comentário, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getTaskOrNullObject(): Excel.DocumentTask;Retornos
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?: Excel.Interfaces.CommentLoadOptions): Excel.Comment;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[]): Excel.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
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
await Excel.run(async (context) => {
const comment = context.workbook.comments.getItemByCell("Comments!A2");
comment.load(["authorEmail", "authorName", "creationDate"]);
await context.sync();
console.log(`${comment.creationDate.toDateString()}: ${comment.authorName} (${comment.authorEmail})`);
await context.sync();
});
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;
}): Excel.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
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
- Excel.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: Excel.Comment): void;Parâmetros
- properties
- Excel.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 objeto Excel.Comment original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CommentData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.CommentData;Retornos
updateMentions(contentWithMentions)
Atualizações o conteúdo do comentário com uma cadeia de caracteres especialmente formatada e uma lista de menções.
updateMentions(contentWithMentions: Excel.CommentRichContent): void;Parâmetros
- contentWithMentions
- Excel.CommentRichContent
O conteúdo do comentário. Isso contém uma cadeia de caracteres especialmente formatada e uma lista de menções que serão analisadas na cadeia de caracteres quando exibidas pelo Excel.
Retornos
void
Comentários
Comentários
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, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de