Excel.Comment class
Representa um comentário na pasta de trabalho.
- Extends
Comentários
[Conjunto de apis: 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 sem formatação. |
| 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ário. |
| mentions | Obtém as entidades (por exemplo, pessoas) mencionadas nos comentários. |
| replies | Representa uma coleção de objetos de resposta associados ao comentário. |
| resolved | O status do thread de comentários. Um valor de significa que o thread de |
| rich |
Obtém o conteúdo de comentário avançado (por exemplo, menções em comentários). Essa cadeia de caracteres não deve ser exibida para os usuários finais. Seu suplemento só deve usar isso para analisar conteúdo de comentário avançado. |
Métodos
| delete() | Exclui o comentário e todas as respostas conectadas. |
| get |
Obtém a célula onde este comentário está localizado. |
| 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
[Conjunto de apis: ExcelApi 1.10]
authorName
Obtém o nome do autor do comentário.
readonly authorName: string;Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.10]
content
O conteúdo do comentário. A cadeia de caracteres é texto sem formatação.
content: string;Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.10]
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
[Conjunto de apis: ExcelApi 1.12]
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, uma vez que o comentário não tem uma data de criação.
readonly creationDate: Date;Valor da propriedade
Date
Comentários
[Conjunto de apis: ExcelApi 1.10]
id
Especifica o identificador de comentário.
readonly id: string;Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.10]
mentions
Obtém as entidades (por exemplo, pessoas) mencionadas nos comentários.
readonly mentions: Excel.CommentMention[];Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.11]
replies
Representa uma coleção de objetos de resposta associados ao comentário.
readonly replies: Excel.CommentReplyCollection;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.10]
resolved
O status do thread de comentários. Um valor de significa que o thread de true comentário foi resolvido.
resolved: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.11]
richContent
Obtém o conteúdo de comentário avançado (por exemplo, menções em comentários). Essa cadeia de caracteres não deve ser exibida para os usuários finais. Seu suplemento só deve usar isso para analisar conteúdo de comentário avançado.
readonly richContent: string;Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.11]
Detalhes do método
delete()
Exclui o comentário e todas as respostas conectadas.
delete(): void;Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.10]
getLocation()
Obtém a célula onde este comentário está localizado.
getLocation(): Excel.Range;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.10]
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 devem ser carregadas.
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írgula ou uma matriz de cadeias de caracteres que especifica 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;
}): Excel.Comment;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula 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 de propriedades tentar definir 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.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.Comment é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CommentData) que contém cópias superficiais de todas as 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 exibida pelo Excel.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.11]