Excel.CommentReply interface

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

Свойства

authorEmail

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

authorName

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

content

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

creationDate

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

id

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

mentions

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

resolved

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

richContent

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

Методы

delete()

Удаляет ответ на примечание.

getLocation()

Получает ячейку, в которой находится этот ответ на комментарий.

getParentComment()

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

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. context.sync()Перед чтением свойств необходимо вызвать метод.

updateMentions(contentWithMentions)

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

Сведения о свойстве

authorEmail

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

readonly authorEmail: string;

Значение свойства

string

authorName

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

readonly authorName: string;

Значение свойства

string

content

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

content: string;

Значение свойства

string

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Comments");
    let comment = sheet.comments.getItemAt(0);
    let reply = comment.replies.getItemAt(0);
    reply.load("content");
    // Sync to load the content of the comment reply.
    await context.sync();

    // Append "Please!" to the end of the comment reply.
    reply.content += " Please!";
    await context.sync();
}

creationDate

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

readonly creationDate: Date;

Значение свойства

Date

id

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

readonly id: string;

Значение свойства

string

mentions

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

readonly mentions: CommentMention[];

Значение свойства

resolved

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

readonly resolved: boolean;

Значение свойства

boolean

richContent

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

readonly richContent: string;

Значение свойства

string

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

delete()

Удаляет ответ на примечание.

delete(): void;

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

void

Примеры

async function main(context: Excel.RequestContext) {
    // Remove the first comment reply from this worksheet's first comment.
    let sheet = context.workbook.worksheets.getItem("Comments");
    let comment = sheet.comments.getItemAt(0);
    comment.replies.getItemAt(0).delete();
    await context.sync();
}

getLocation()

Получает ячейку, в которой находится этот ответ на комментарий.

getLocation(): Range;

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

getParentComment()

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

getParentComment(): Comment;

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

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. context.sync()Перед чтением свойств необходимо вызвать метод.

load(propertyNames?: string | string[]): void;

Параметры

propertyNames
string | string[]

Строка, разделенная запятыми, или массив строк, указывающий свойства для загрузки.

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

void

updateMentions(contentWithMentions)

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

updateMentions(contentWithMentions: CommentRichContent): void;

Параметры

contentWithMentions
CommentRichContent

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

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

void