ExcelScript.Comment interface

Pacote:

ExcelScript

Representa um comentário no livro.

Métodos

addCommentReply(content, contentType)	Cria uma resposta de comentário para um comentário.
delete()	Elimina o comentário e todas as respostas ligadas.
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, este método devolve undefined.
getContent()	O conteúdo do comentário. A cadeia é 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. Devolve null se o comentário tiver sido convertido de uma nota, uma vez que o comentário não tem uma data de criação.
getId()	Especifica o identificador de comentário.
getLocation()	Obtém a célula onde este 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 tópico de comentários status. Um valor de true significa que o tópico de comentários é resolvido.
getRichContent()	Obtém o conteúdo de comentário avançado (por exemplo, menções nos comentários). Esta cadeia não se destina a ser apresentada aos utilizadores finais. O seu suplemento só deve utilizá-lo para analisar conteúdos de comentários avançados.
setContent(content)	O conteúdo do comentário. A cadeia é texto simples.
setResolved(resolved)	O tópico de comentários status. Um valor de true significa que o tópico de comentários é resolvido.
updateMentions(contentWithMentions)	Atualizações o conteúdo do comentário com uma cadeia de carateres 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 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 predefinido é enum ContentType.Plain.

Retornos

ExcelScript.CommentReply

delete()

Elimina o comentário e todas as respostas ligadas.

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, este método devolve undefined.

getCommentReply(commentReplyId: string): CommentReply | undefined;

Parâmetros

commentReplyId

string

O identificador da resposta do comentário.

Retornos

ExcelScript.CommentReply | undefined

getContent()

O conteúdo do comentário. A cadeia é 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. Devolve null se o comentário tiver sido 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

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 tópico de comentários status. Um valor de true significa que o tópico de comentários é resolvido.

getResolved(): boolean;

Retornos

boolean

getRichContent()

Obtém o conteúdo de comentário avançado (por exemplo, menções nos comentários). Esta cadeia não se destina a ser apresentada aos utilizadores finais. O seu suplemento só deve utilizá-lo para analisar conteúdos de comentários avançados.

getRichContent(): string;

Retornos

string

setContent(content)

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

setContent(content: string): void;

Parâmetros

content

string

Retornos

void

setResolved(resolved)

O tópico de comentários status. Um valor de true significa que o tópico de comentários é 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 carateres especialmente formatada e uma lista de menções.

updateMentions(contentWithMentions: CommentRichContent): void;

Parâmetros

contentWithMentions

ExcelScript.CommentRichContent

O conteúdo do comentário. Contém uma cadeia de carateres especialmente formatada e uma lista de menções que serão analisadas na cadeia quando apresentadas pelo Excel.

Retornos

void