Excel.Comment class
Представляет комментарий в книге.
- Extends
Комментарии
Свойства
| author |
Получает электронную почту автора примечания. |
| author |
Получает имя автора примечания. |
| content | Содержимое комментария. Строка представляет собой обычный текст. |
| content |
Возвращает тип содержимого комментария. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| creation |
Получает время создания примечания. Возвращает значение |
| id | Указывает идентификатор комментария. |
| mentions | Возвращает сущности (например, люди), упомянутые в комментариях. |
| replies | Представляет коллекцию объектов ответов, связанных с примечанием. |
| resolved | Состояние потока комментариев. Значение |
| rich |
Возвращает содержимое полнофункционированного комментария (например, упоминания в комментариях). Эта строка не предназначена для отображения для конечных пользователей. Надстройка должна использовать его только для анализа содержимого расширенных комментариев. |
Методы
| assign |
Назначает задачу, связанную с комментарием, данному пользователю в качестве назначенного. Если задачи нет, она будет создана. |
| delete() | Удаляет комментарий и все подключенные ответы. |
| 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-comment/comment-basics.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
comment.content = "PLEASE add headers here.";
await context.sync();
});
contentType
Возвращает тип содержимого комментария.
readonly contentType: Excel.ContentType | "Plain" | "Mention";Значение свойства
Excel.ContentType | "Plain" | "Mention"
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
creationDate
Получает время создания примечания. Возвращает значение null , если комментарий был преобразован из заметки, так как у комментария нет даты создания.
readonly creationDate: Date;Значение свойства
Date
Комментарии
id
Указывает идентификатор комментария.
readonly id: string;Значение свойства
string
Комментарии
mentions
Возвращает сущности (например, люди), упомянутые в комментариях.
readonly mentions: Excel.CommentMention[];Значение свойства
Комментарии
replies
Представляет коллекцию объектов ответов, связанных с примечанием.
readonly replies: Excel.CommentReplyCollection;Значение свойства
Комментарии
resolved
Состояние потока комментариев. Значение true означает, что поток комментариев разрешен.
resolved: boolean;Значение свойства
boolean
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-resolution.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Comments");
sheet.comments.getItemAt(0).resolved = true;
await context.sync();
});
richContent
Возвращает содержимое полнофункционированного комментария (например, упоминания в комментариях). Эта строка не предназначена для отображения для конечных пользователей. Надстройка должна использовать его только для анализа содержимого расширенных комментариев.
readonly richContent: string;Значение свойства
string
Комментарии
Сведения о методе
assignTask(assignee)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Назначает задачу, связанную с комментарием, данному пользователю в качестве назначенного. Если задачи нет, она будет создана.
assignTask(assignee: Excel.EmailIdentity): Excel.DocumentTask;Параметры
- assignee
- Excel.EmailIdentity
Сведения об удостоверениях пользователя назначенного.
Возвращаемое значение
Комментарии
[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]
delete()
Удаляет комментарий и все подключенные ответы.
delete(): void;Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
await Excel.run(async (context) => {
context.workbook.comments.getItemByCell("Comments!A2").delete();
await context.sync();
});
getLocation()
Возвращает ячейку, в которой находится это примечание.
getLocation(): Excel.Range;Возвращаемое значение
Комментарии
getTask()
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает задачу, связанную с этим комментарием. Если для потока комментариев нет задачи, ItemNotFound возникает исключение.
getTask(): Excel.DocumentTask;Возвращаемое значение
Комментарии
[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]
getTaskOrNullObject()
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает задачу, связанную с этим комментарием. Если для потока комментариев нет задачи, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getTaskOrNullObject(): Excel.DocumentTask;Возвращаемое значение
Комментарии
[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.CommentLoadOptions): Excel.Comment;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.Comment;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
await Excel.run(async (context) => {
const comment = context.workbook.comments.getItemByCell("Comments!A2");
comment.load(["authorEmail", "authorName", "creationDate"]);
await context.sync();
console.log(`${comment.creationDate.toDateString()}: ${comment.authorName} (${comment.authorEmail})`);
await context.sync();
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Comment;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.CommentUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Excel.Comment): void;Параметры
- properties
- Excel.Comment
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.Comment является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.CommentData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.CommentData;Возвращаемое значение
updateMentions(contentWithMentions)
Обновления содержимое комментария со специально отформатированной строкой и списком упоминаний.
updateMentions(contentWithMentions: Excel.CommentRichContent): void;Параметры
- contentWithMentions
- Excel.CommentRichContent
Содержимое комментария. Он содержит специально отформатированную строку и список упоминаний, которые будут проанализированы в строку при отображении в Excel.
Возвращаемое значение
void
Комментарии
Office Add-ins
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по