ExcelScript.Comment interface

Paquete:

ExcelScript

Representa un comentario en el libro.

Métodos

addCommentReply(content, contentType)	Crea una respuesta de comentario para un comentario.
delete()	Elimina el comentario y todas las respuestas conectadas.
getAuthorEmail()	Obtiene el correo electrónico del autor del comentario.
getAuthorName()	Obtiene el nombre del autor del comentario.
getCommentReply(commentReplyId)	Devuelve una respuesta de comentario identificada por su Id. Si el objeto de respuesta de comentario no existe, este método devuelve undefined.
getContent()	Contenido del comentario. La cadena es texto sin formato.
getContentType()	Obtiene el tipo de contenido del comentario.
getCreationDate()	Obtiene la hora de creación del comentario. Devuelve null si el comentario se ha convertido a partir de una nota, ya que el comentario no tiene una fecha de creación.
getId()	Especifica el identificador de comentario.
getLocation()	Obtiene la celda donde se encuentra este comentario.
getMentions()	Obtiene las entidades (por ejemplo, personas) que se mencionan en los comentarios.
getReplies()	Indica una colección de objetos de respuesta asociados con el comentario.
getResolved()	Estado del subproceso de comentario. Un valor de true significa que el subproceso de comentario se resuelve.
getRichContent()	Obtiene el contenido de comentario enriquecido (por ejemplo, las menciones en los comentarios). Esta cadena no está pensada para mostrarse a los usuarios finales. El complemento solo debe usarlo para analizar contenido de comentarios enriquecidos.
setContent(content)	Contenido del comentario. La cadena es texto sin formato.
setResolved(resolved)	Estado del subproceso de comentario. Un valor de true significa que el subproceso de comentario se resuelve.
updateMentions(contentWithMentions)	Novedades el contenido del comentario con una cadena con formato especial y una lista de menciones.

Detalles del método

addCommentReply(content, contentType)

Crea una respuesta de comentario para un comentario.

addCommentReply(
            content: CommentRichContent | string,
            contentType?: ContentType
        ): CommentReply;

Parámetros

content

ExcelScript.CommentRichContent | string

Contenido del comentario. Puede ser una cadena o un CommentRichContent objeto (por ejemplo, para comentarios con menciones).

contentType

ExcelScript.ContentType

Opcional. Tipo de contenido contenido en el comentario. El valor predeterminado es enum ContentType.Plain.

Devoluciones

ExcelScript.CommentReply

delete()

Elimina el comentario y todas las respuestas conectadas.

delete(): void;

Devoluciones

void

getAuthorEmail()

Obtiene el correo electrónico del autor del comentario.

getAuthorEmail(): string;

Devoluciones

string

getAuthorName()

Obtiene el nombre del autor del comentario.

getAuthorName(): string;

Devoluciones

string

getCommentReply(commentReplyId)

Devuelve una respuesta de comentario identificada por su Id. Si el objeto de respuesta de comentario no existe, este método devuelve undefined.

getCommentReply(commentReplyId: string): CommentReply | undefined;

Parámetros

commentReplyId

string

Identificador de la respuesta de comentario.

Devoluciones

ExcelScript.CommentReply | undefined

getContent()

Contenido del comentario. La cadena es texto sin formato.

getContent(): string;

Devoluciones

string

getContentType()

Obtiene el tipo de contenido del comentario.

getContentType(): ContentType;

Devoluciones

ExcelScript.ContentType

getCreationDate()

Obtiene la hora de creación del comentario. Devuelve null si el comentario se ha convertido a partir de una nota, ya que el comentario no tiene una fecha de creación.

getCreationDate(): Date;

Devoluciones

Date

getId()

Especifica el identificador de comentario.

getId(): string;

Devoluciones

string

getLocation()

Obtiene la celda donde se encuentra este comentario.

getLocation(): Range;

Devoluciones

ExcelScript.Range

getMentions()

Obtiene las entidades (por ejemplo, personas) que se mencionan en los comentarios.

getMentions(): CommentMention[];

Devoluciones

ExcelScript.CommentMention[]

getReplies()

Indica una colección de objetos de respuesta asociados con el comentario.

getReplies(): CommentReply[];

Devoluciones

ExcelScript.CommentReply[]

getResolved()

Estado del subproceso de comentario. Un valor de true significa que el subproceso de comentario se resuelve.

getResolved(): boolean;

Devoluciones

boolean

getRichContent()

Obtiene el contenido de comentario enriquecido (por ejemplo, las menciones en los comentarios). Esta cadena no está pensada para mostrarse a los usuarios finales. El complemento solo debe usarlo para analizar contenido de comentarios enriquecidos.

getRichContent(): string;

Devoluciones

string

setContent(content)

Contenido del comentario. La cadena es texto sin formato.

setContent(content: string): void;

Parámetros

content

string

Devoluciones

void

setResolved(resolved)

Estado del subproceso de comentario. Un valor de true significa que el subproceso de comentario se resuelve.

setResolved(resolved: boolean): void;

Parámetros

resolved

boolean

Devoluciones

void

updateMentions(contentWithMentions)

Novedades el contenido del comentario con una cadena con formato especial y una lista de menciones.

updateMentions(contentWithMentions: CommentRichContent): void;

Parámetros

contentWithMentions

ExcelScript.CommentRichContent

Contenido del comentario. Contiene una cadena con formato especial y una lista de menciones que se analizarán en la cadena cuando Excel la muestre.

Devoluciones

void