ExcelScript.Comment interface

Pacote:

ExcelScript

Representa um comentário na pasta de trabalho.

Métodos

addCommentReply(content, contentType)	Cria uma resposta de comentário para um comentário.
delete()	Exclui o comentário e todas as respostas conectadas.
getAuthorEmail()	Obtém o email do autor do comentário.
getAuthorName()	Obtém o nome do autor do comentário.
getCommentReply(commentReplyId)	Retorna uma resposta de comentário identificada pela respectiva ID. Se o objeto de resposta de comentário não existir, esse método retornará undefined.
getContent()	O conteúdo do comentário. A cadeia de caracteres é texto simples.
getContentType()	Obtém o tipo de conteúdo do comentário.
getCreationDate()	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.
getId()	Especifica o identificador de comentários.
getLocation()	Obtém a célula em que esse comentário está localizado.
getMentions()	Obtém as entidades (por exemplo, pessoas) que são mencionadas nos comentários.
getReplies()	Representa uma coleção de objetos de resposta associados ao comentário.
getResolved()	O thread de comentários status. Um valor de true significa que o thread de comentário foi resolvido.
getRichContent()	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.
setContent(content)	O conteúdo do comentário. A cadeia de caracteres é texto simples.
setResolved(resolved)	O thread de comentários status. Um valor de true significa que o thread de comentário foi resolvido.
updateMentions(contentWithMentions)	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. Isso 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 é enumerar ContentType.Plain.

Retornos

ExcelScript.CommentReply

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 de comentário não existir, esse método retornará undefined.

getCommentReply(commentReplyId: string): CommentReply | undefined;

Parâmetros

commentReplyId

string

O identificador da resposta de comentário.

Retornos

ExcelScript.CommentReply | undefined

getContent()

O conteúdo do comentário. A cadeia de caracteres é texto simples.

getContent(): string;

Retornos

string

getContentType()

Obtém o tipo de conteúdo do comentário.

getContentType(): ContentType;

Retornos

ExcelScript.ContentType

getCreationDate()

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.

getCreationDate(): Date;

Retornos

Date

getId()

Especifica o identificador de comentários.

getId(): string;

Retornos

string

getLocation()

Obtém a célula em que esse comentário está localizado.

getLocation(): Range;

Retornos

ExcelScript.Range

getMentions()

Obtém as entidades (por exemplo, pessoas) que são mencionadas nos comentários.

getMentions(): CommentMention[];

Retornos

ExcelScript.CommentMention[]

getReplies()

Representa uma coleção de objetos de resposta associados ao comentário.

getReplies(): CommentReply[];

Retornos

ExcelScript.CommentReply[]

getResolved()

O thread de comentários status. Um valor de true significa que o thread de comentário foi resolvido.

getResolved(): boolean;

Retornos

boolean

getRichContent()

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.

getRichContent(): string;

Retornos

string

setContent(content)

O conteúdo do comentário. A cadeia de caracteres é texto simples.

setContent(content: string): void;

Parâmetros

content

string

Retornos

void

setResolved(resolved)

O thread de comentários status. Um valor de true significa que o thread de 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 exibidas pelo Excel.

Retornos

void