Excel.CommentReply class

Ссылка

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

Свойства

authorEmail	Получает электронную почту автора ответа на примечание.
authorName	Получает имя автора ответа на примечание.
content	Содержимое ответа примечания. Строка представляет собой обычный текст.
contentType	Тип содержимого ответа.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
creationDate	Получает время создания ответа на примечание.
id	Указывает идентификатор ответа на комментарий.
mentions	Сущности (например, люди), упомянутые в комментариях.
resolved	Состояние ответа на комментарий. Значение `true` означает, что ответ находится в разрешенном состоянии.
richContent	Содержимое примечаний (например, упоминания в комментариях). Эта строка не предназначена для отображения для конечных пользователей. Надстройка должна использовать его только для анализа содержимого расширенных комментариев.

Методы

delete()	Удаляет ответ на примечание.
getLocation()	Возвращает ячейку, в которой находится этот ответ на комментарий.
getParentComment()	Возвращает родительский комментарий этого ответа.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.CommentReply` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.CommentReplyData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
updateMentions(contentWithMentions)	Обновления содержимое комментария со специально отформатированной строкой и списком упоминаний.

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

authorEmail

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

readonly authorEmail: string;

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

string

authorName

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

readonly authorName: string;

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

string

content

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

content: string;

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

string

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-replies.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    const 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();
});

contentType

Тип содержимого ответа.

readonly contentType: Excel.ContentType | "Plain" | "Mention";

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

Excel.ContentType | "Plain" | "Mention"

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

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

Excel.RequestContext

creationDate

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

readonly creationDate: Date;

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

Date

id

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

readonly id: string;

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

string

mentions

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

readonly mentions: Excel.CommentMention[];

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

Excel.CommentMention[]

resolved

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

readonly resolved: boolean;

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

boolean

richContent

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

readonly richContent: string;

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

string

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

delete()

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

delete(): void;

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-replies.yaml

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

getLocation()

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

getLocation(): Excel.Range;

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

Excel.Range

getParentComment()

Возвращает родительский комментарий этого ответа.

getParentComment(): Excel.Comment;

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

Excel.Comment

load(options)

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

load(options?: Excel.Interfaces.CommentReplyLoadOptions): Excel.CommentReply;

Параметры

options: Excel.Interfaces.CommentReplyLoadOptions

Предоставляет параметры свойств объекта для загрузки.

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

Excel.CommentReply

load(propertyNames)

load(propertyNames?: string | string[]): Excel.CommentReply;

Параметры

propertyNames: string | string[]

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

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

Excel.CommentReply

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.CommentReply;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

Excel.CommentReply

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Excel.Interfaces.CommentReplyUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.CommentReply): void;

Параметры

properties: Excel.CommentReply

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

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.CommentReply объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.CommentReplyData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.CommentReplyData;

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

Excel.Interfaces.CommentReplyData

updateMentions(contentWithMentions)

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

updateMentions(contentWithMentions: Excel.CommentRichContent): void;

Параметры

contentWithMentions: Excel.CommentRichContent

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

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

void

Поделиться через

Excel.CommentReply class

Комментарии

Свойства

Методы

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

authorEmail

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

Комментарии

authorName

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

Комментарии

content

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

Комментарии

Примеры

contentType

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

Комментарии

context

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

creationDate

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

Комментарии

id

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

Комментарии

mentions

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

Комментарии

resolved

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

Комментарии

richContent

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

Комментарии

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

delete()

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

Комментарии

Примеры

getLocation()

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

Комментарии

getParentComment()

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

updateMentions(contentWithMentions)

Параметры

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

Комментарии

Дополнительные ресурсы