ExcelScript.Comment interface
Representa um comentário na pasta de trabalho.
Comentários
Usada por
Métodos
| add |
Cria uma resposta de comentário para um comentário. |
| delete() | Exclui o comentário e todas as respostas conectadas. |
| get |
Obtém o email do autor do comentário. |
| get |
Obtém o nome do autor do comentário. |
| get |
Retorna uma resposta de comentário identificada pela respectiva ID. Se o objeto de resposta do comentário não existir, esse método retornará |
| get |
O conteúdo do comentário. A cadeia de caracteres é texto sem formatação. |
| get |
Obtém o tipo de conteúdo do comentário. |
| get |
Obtém o horário de criação do comentário. Retorna |
| get |
Especifica o identificador de comentário. |
| get |
Obtém a célula onde este comentário está localizado. |
| get |
Obtém as entidades (por exemplo, pessoas) mencionadas nos comentários. |
| get |
Representa uma coleção de objetos de resposta associados ao comentário. |
| get |
O status do thread de comentários. Um valor de significa que o thread de |
| get |
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. |
| set |
O conteúdo do comentário. A cadeia de caracteres é texto sem formatação. |
| set |
O status do thread de comentários. Um valor de significa que o thread de |
| update |
Atualizações o conteúdo do comentário com uma cadeia de caracteres especialmente formatada e uma lista de menções. |
Detalhes do método
addCommentReply(content, contentType)
Cria uma resposta de comentário para um comentário.
addCommentReply(
content: CommentRichContent | string,
contentType?: ContentType
): CommentReply;
Parâmetros
- content
-
ExcelScript.CommentRichContent | string
O conteúdo do comentário. Pode ser uma cadeia de caracteres ou um CommentRichContent objeto (por exemplo, para comentários com menções).
- contentType
- ExcelScript.ContentType
Opcional. O tipo de conteúdo contido no comentário. O valor padrão é enum ContentType.Plain.
Retornos
delete()
Exclui o comentário e todas as respostas conectadas.
delete(): void;
Retornos
void
getAuthorEmail()
Obtém o email do autor do comentário.
getAuthorEmail(): string;
Retornos
string
getAuthorName()
Obtém o nome do autor do comentário.
getAuthorName(): string;
Retornos
string
getCommentReply(commentReplyId)
Retorna uma resposta de comentário identificada pela respectiva ID. Se o objeto de resposta do comentário não existir, esse método retornará undefined.
getCommentReply(commentReplyId: string): CommentReply | undefined;
Parâmetros
- commentReplyId
-
string
O identificador para a resposta do comentário.
Retornos
ExcelScript.CommentReply | undefined
getContent()
O conteúdo do comentário. A cadeia de caracteres é texto sem formatação.
getContent(): string;
Retornos
string
getContentType()
Obtém o tipo de conteúdo do comentário.
getContentType(): ContentType;
Retornos
getCreationDate()
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.
getCreationDate(): Date;
Retornos
Date
getId()
Especifica o identificador de comentário.
getId(): string;
Retornos
string
getLocation()
Obtém a célula onde este comentário está localizado.
getLocation(): Range;
Retornos
getMentions()
Obtém as entidades (por exemplo, pessoas) mencionadas nos comentários.
getMentions(): CommentMention[];
Retornos
getReplies()
Representa uma coleção de objetos de resposta associados ao comentário.
getReplies(): CommentReply[];
Retornos
getResolved()
O status do thread de comentários. Um valor de significa que o thread de true comentário foi resolvido.
getResolved(): boolean;
Retornos
boolean
getRichContent()
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.
getRichContent(): string;
Retornos
string
setContent(content)
O conteúdo do comentário. A cadeia de caracteres é texto sem formatação.
setContent(content: string): void;
Parâmetros
- content
-
string
Retornos
void
setResolved(resolved)
O status do thread de comentários. Um valor de significa que o thread de true comentário foi resolvido.
setResolved(resolved: boolean): void;
Parâmetros
- resolved
-
boolean
Retornos
void
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: CommentRichContent): void;
Parâmetros
- contentWithMentions
- ExcelScript.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