Excel.Comment class
Представляет примечание в книге.
- Extends
Комментарии
Используется
Свойства
| author |
Получает электронную почту автора примечания. |
| author |
Получает имя автора примечания. |
| content | Содержание комментария. Строка представляет собой обычный текст. |
| content |
Получает тип содержимого комментария. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| creation |
Получает время создания примечания. Возвращает |
| id | Указывает идентификатор комментария. |
| mentions | Получает сущности (например, людей), упомянутых в комментариях. |
| replies | Представляет коллекцию объектов ответов, связанных с примечанием. |
| resolved | Состояние цепочки комментариев. Значение of |
| 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-comments-and-notes/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;Значение свойства
Комментарии
Примеры
// 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) => {
// Adds a reply to the first comment in this worksheet.
const sheet = context.workbook.worksheets.getItem("Comments");
const comment: Excel.Comment = sheet.comments.getItemAt(0);
comment.replies.add("Add content to this worksheet.");
await context.sync();
});
resolved
Состояние цепочки комментариев. Значение of true означает, что цепочка комментариев разрешена.
resolved: boolean;Значение свойства
boolean
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/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
Сведения об удостоверении пользователя уполномоченного лица.
Возвращаемое значение
Комментарии
delete()
Удаляет комментарий и все связанные ответы.
delete(): void;Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/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;Возвращаемое значение
Комментарии
getTaskOrNullObject()
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает задачу, связанную с этим комментарием. Если для цепочки комментариев нет задачи, то этот метод возвращает объект со свойством isNullObject , установленным в trueзначение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getTaskOrNullObject(): Excel.DocumentTask;Возвращаемое значение
Комментарии
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-comments-and-notes/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
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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