Excel.CommentReply class
Представляет ответ на примечание в книге.
- Extends
Комментарии
Используется
Свойства
| author |
Получает электронную почту автора ответа на примечание. |
| author |
Получает имя автора ответа на примечание. |
| content | Содержание ответа на комментарий. Строка представляет собой обычный текст. |
| content |
Тип содержимого ответа. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| creation |
Получает время создания ответа на примечание. |
| id | Указывает идентификатор ответа на примечание. |
| mentions | Сущности (например, люди), упомянутые в комментариях. |
| resolved | Состояние ответа на примечание. Значение "of" |
| rich |
Расширенное содержимое комментариев (например, упоминания в комментариях). Эта строка не предназначена для отображения конечным пользователям. Надстройка должна использовать эту функцию только для анализа содержимого комментариев. |
Методы
| assign |
Назначает задачу, прикрепленную к комментарию, данному пользователю в качестве единственного уполномоченного. Если задачи нет, она будет создана. |
| delete() | Удаляет ответ на примечание. |
| get |
Получает ячейку, в которой находится этот ответ на примечание. |
| get |
Получает родительский комментарий этого ответа. |
| get |
Получает задачу, связанную с цепочкой ответов на этот комментарий. Если задача для цепочки комментариев отсутствует, |
| get |
Получает задачу, связанную с цепочкой ответов на этот комментарий. Если для цепочки комментариев нет задачи, то этот метод возвращает объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
| update |
Обновления содержимого комментария со специально отформатированной строкой и списком упоминаний. |
Сведения о свойстве
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-comments-and-notes/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;Значение свойства
creationDate
Получает время создания ответа на примечание.
readonly creationDate: Date;Значение свойства
Date
Комментарии
id
Указывает идентификатор ответа на примечание.
readonly id: string;Значение свойства
string
Комментарии
mentions
Сущности (например, люди), упомянутые в комментариях.
readonly mentions: Excel.CommentMention[];Значение свойства
Комментарии
resolved
Состояние ответа на примечание. Значение "of" true означает, что ответ находится в разрешенном состоянии.
readonly resolved: boolean;Значение свойства
boolean
Комментарии
richContent
Расширенное содержимое комментариев (например, упоминания в комментариях). Эта строка не предназначена для отображения конечным пользователям. Надстройка должна использовать эту функцию только для анализа содержимого комментариев.
readonly richContent: string;Значение свойства
string
Комментарии
Сведения о методе
assignTask(assignee)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Назначает задачу, прикрепленную к комментарию, данному пользователю в качестве единственного уполномоченного. Если задачи нет, она будет создана.
assignTask(assignee: Excel.EmailIdentity): Excel.DocumentTask;Параметры
- assignee
- Excel.EmailIdentity
Сведения об удостоверении пользователя уполномоченного лица.
Возвращаемое значение
Комментарии
delete()
Удаляет ответ на примечание.
delete(): void;Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/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;Возвращаемое значение
Комментарии
getParentComment()
Получает родительский комментарий этого ответа.
getParentComment(): Excel.Comment;Возвращаемое значение
Комментарии
getTask()
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает задачу, связанную с цепочкой ответов на этот комментарий. Если задача для цепочки комментариев отсутствует, ItemNotFound создается исключение.
getTask(): Excel.DocumentTask;Возвращаемое значение
Комментарии
getTaskOrNullObject()
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает задачу, связанную с цепочкой ответов на этот комментарий. Если для цепочки комментариев нет задачи, то этот метод возвращает объект со свойством isNullObject , установленным в trueзначение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getTaskOrNullObject(): Excel.DocumentTask;Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.CommentReplyLoadOptions): Excel.CommentReply;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.CommentReply;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.CommentReply;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.CommentReplyUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;Возвращаемое значение
updateMentions(contentWithMentions)
Обновления содержимого комментария со специально отформатированной строкой и списком упоминаний.
updateMentions(contentWithMentions: Excel.CommentRichContent): void;Параметры
- contentWithMentions
- Excel.CommentRichContent
Содержимое комментария. Он содержит специально отформатированную строку и список упоминаний, которые будут преобразованы в строку при отображении в Excel.
Возвращаемое значение
void