Word.CommentReply class
Представляет ответ примечания в документе.
- Extends
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Replies to the first active comment in the selected content.
await Word.run(async (context) => {
const text = $("#reply-text")
.val()
.toString();
const comments: Word.CommentCollection = context.document.getSelection().getComments();
comments.load("items");
await context.sync();
const firstActiveComment: Word.Comment = comments.items.find((item) => item.resolved !== true);
if (firstActiveComment) {
const reply: Word.CommentReply = firstActiveComment.reply(text);
console.log("Reply added.");
} else {
console.warn("No active comment was found in the selection, so couldn't reply.");
}
});
Свойства
| author |
Получает электронную почту автора ответа на примечание. |
| author |
Получает имя автора ответа на примечание. |
| content | Указывает содержимое ответа примечания. Строка представляет собой обычный текст. |
| content |
Указывает диапазон содержимого commentReply. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| creation |
Возвращает дату создания ответа на комментарий. |
| id | Возвращает идентификатор ответа на комментарий. |
| parent |
Возвращает родительский комментарий этого ответа. |
Методы
| delete() | Удаляет ответ на примечание. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
authorEmail
Получает электронную почту автора ответа на примечание.
readonly authorEmail: string;Значение свойства
string
Комментарии
authorName
Получает имя автора ответа на примечание.
readonly authorName: string;Значение свойства
string
Комментарии
content
Указывает содержимое ответа примечания. Строка представляет собой обычный текст.
content: string;Значение свойства
string
Комментарии
contentRange
Указывает диапазон содержимого commentReply.
contentRange: Word.CommentContentRange;Значение свойства
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
creationDate
Возвращает дату создания ответа на комментарий.
readonly creationDate: Date;Значение свойства
Date
Комментарии
id
Возвращает идентификатор ответа на комментарий.
readonly id: string;Значение свойства
string
Комментарии
parentComment
Возвращает родительский комментарий этого ответа.
readonly parentComment: Word.Comment;Значение свойства
Комментарии
Сведения о методе
delete()
Удаляет ответ на примечание.
delete(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.CommentReplyLoadOptions): Word.CommentReply;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.CommentReply;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.CommentReply;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.CommentReplyUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Word.CommentReply): void;Параметры
- properties
- Word.CommentReply
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.CommentReply объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.CommentReplyData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Word.Interfaces.CommentReplyData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.CommentReply;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.CommentReply;Возвращаемое значение
Office Add-ins