ExcelScript.Comment interface

Пакет:

ExcelScript

Представляет комментарий в книге.

Методы

addCommentReply(content, contentType)	Создает ответ примечания для комментария.
delete()	Удаляет комментарий и все подключенные ответы.
getAuthorEmail()	Получает электронную почту автора примечания.
getAuthorName()	Получает имя автора примечания.
getCommentReply(commentReplyId)	Возвращает ответ на примечание, определенное по идентификатору. Если объект comment reply не существует, этот метод возвращает undefined.
getContent()	Содержимое комментария. Строка представляет собой обычный текст.
getContentType()	Возвращает тип содержимого комментария.
getCreationDate()	Получает время создания примечания. Возвращает значение null , если комментарий был преобразован из заметки, так как у комментария нет даты создания.
getId()	Указывает идентификатор комментария.
getLocation()	Возвращает ячейку, в которой находится это примечание.
getMentions()	Возвращает сущности (например, люди), упомянутые в комментариях.
getReplies()	Представляет коллекцию объектов ответов, связанных с примечанием.
getResolved()	Состояние потока комментариев. Значение true означает, что поток комментариев разрешен.
getRichContent()	Возвращает содержимое полнофункционированного комментария (например, упоминания в комментариях). Эта строка не предназначена для отображения для конечных пользователей. Надстройка должна использовать его только для анализа содержимого расширенных комментариев.
setContent(content)	Содержимое комментария. Строка представляет собой обычный текст.
setResolved(resolved)	Состояние потока комментариев. Значение true означает, что поток комментариев разрешен.
updateMentions(contentWithMentions)	Обновления содержимое комментария со специально отформатированными строками и списком упоминаний.

Сведения о методе

addCommentReply(content, contentType)

Создает ответ примечания для комментария.

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

Параметры

content

ExcelScript.CommentRichContent | string

Содержимое комментария. Это может быть строка или CommentRichContent объект (например, для комментариев с упоминаниями).

contentType

ExcelScript.ContentType

Необязательный параметр. Тип содержимого, содержащегося в комментарии. Значение по умолчанию — перечисление ContentType.Plain.

Возвращаемое значение

ExcelScript.CommentReply

delete()

Удаляет комментарий и все подключенные ответы.

delete(): void;

Возвращаемое значение

void

getAuthorEmail()

Получает электронную почту автора примечания.

getAuthorEmail(): string;

Возвращаемое значение

string

getAuthorName()

Получает имя автора примечания.

getAuthorName(): string;

Возвращаемое значение

string

getCommentReply(commentReplyId)

Возвращает ответ на примечание, определенное по идентификатору. Если объект comment reply не существует, этот метод возвращает undefined.

getCommentReply(commentReplyId: string): CommentReply | undefined;

Параметры

commentReplyId

string

Идентификатор ответа на комментарий.

Возвращаемое значение

ExcelScript.CommentReply | undefined

getContent()

Содержимое комментария. Строка представляет собой обычный текст.

getContent(): string;

Возвращаемое значение

string

getContentType()

Возвращает тип содержимого комментария.

getContentType(): ContentType;

Возвращаемое значение

ExcelScript.ContentType

getCreationDate()

Получает время создания примечания. Возвращает значение null , если комментарий был преобразован из заметки, так как у комментария нет даты создания.

getCreationDate(): Date;

Возвращаемое значение

Date

getId()

Указывает идентификатор комментария.

getId(): string;

Возвращаемое значение

string

getLocation()

Возвращает ячейку, в которой находится это примечание.

getLocation(): Range;

Возвращаемое значение

ExcelScript.Range

getMentions()

Возвращает сущности (например, люди), упомянутые в комментариях.

getMentions(): CommentMention[];

Возвращаемое значение

ExcelScript.CommentMention[]

getReplies()

Представляет коллекцию объектов ответов, связанных с примечанием.

getReplies(): CommentReply[];

Возвращаемое значение

ExcelScript.CommentReply[]

getResolved()

Состояние потока комментариев. Значение true означает, что поток комментариев разрешен.

getResolved(): boolean;

Возвращаемое значение

boolean

getRichContent()

Возвращает содержимое полнофункционированного комментария (например, упоминания в комментариях). Эта строка не предназначена для отображения для конечных пользователей. Надстройка должна использовать его только для анализа содержимого расширенных комментариев.

getRichContent(): string;

Возвращаемое значение

string

setContent(content)

Содержимое комментария. Строка представляет собой обычный текст.

setContent(content: string): void;

Параметры

content

string

Возвращаемое значение

void

setResolved(resolved)

Состояние потока комментариев. Значение true означает, что поток комментариев разрешен.

setResolved(resolved: boolean): void;

Параметры

resolved

boolean

Возвращаемое значение

void

updateMentions(contentWithMentions)

Обновления содержимое комментария со специально отформатированными строками и списком упоминаний.

updateMentions(contentWithMentions: CommentRichContent): void;

Параметры

contentWithMentions

ExcelScript.CommentRichContent

Содержимое комментария. Он содержит специально отформатированную строку и список упоминаний, которые будут проанализированы в строку при отображении в Excel.

Возвращаемое значение

void