Word.CommentReply class

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

// 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 = (document.getElementById("reply-text") as HTMLInputElement).value;
  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.");
  }
});

Свойства

authorEmail	Получает электронную почту автора ответа на примечание.
authorName	Получает имя автора ответа на примечание.
content	Указывает содержимое ответа на примечание. Строка представляет собой обычный текст.
contentRange	Определяет диапазон содержимого commentReply.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
creationDate	Получает дату создания ответа на примечание.
id	Получает идентификатор ответа на комментарий.
parentComment	Получает родительский комментарий этого ответа.

Методы

delete()	Удаляет ответ на примечание.
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` метод переданного ему объекта.) В то время как исходный `Word.CommentReply` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Word.Interfaces.CommentReplyData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех `.sync` вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить `context.sync()` , прежде чем освобождение памяти вступит в силу.

authorEmail

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

readonly authorEmail: string;

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

string

authorName

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

readonly authorName: string;

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

string

content

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

content: string;

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

string

contentRange

Определяет диапазон содержимого commentReply.

contentRange: Word.CommentContentRange;

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

Word.CommentContentRange

context

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

context: RequestContext;

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

Word.RequestContext

creationDate

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

readonly creationDate: Date;

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

Date

id

Получает идентификатор ответа на комментарий.

readonly id: string;

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

string

parentComment

Получает родительский комментарий этого ответа.

readonly parentComment: Word.Comment;

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

Word.Comment

delete()

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

delete(): void;

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

void

load(options)

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

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

Параметры

options: Word.Interfaces.CommentReplyLoadOptions

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

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

Word.CommentReply

load(propertyNames)

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

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

Параметры

propertyNames: string | string[]

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

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

Word.CommentReply

load(propertyNamesAndPaths)

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

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

Параметры

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

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

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

Word.CommentReply

set(properties, options)

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

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

Параметры

properties: Word.Interfaces.CommentReplyUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

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;

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

Word.Interfaces.CommentReplyData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.

track(): Word.CommentReply;

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

Word.CommentReply

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

untrack(): Word.CommentReply;

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

Word.CommentReply

Комментарии

Используется

Примеры

Свойства

Методы

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

authorEmail

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

Комментарии

authorName

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

Комментарии

content

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

Комментарии

contentRange

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

Комментарии

context

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

creationDate

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

Комментарии

id

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

Комментарии

parentComment

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

Комментарии

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

delete()

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

track()

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

untrack()

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

Обратная связь