Word.Comment class

Ссылка

Пакет:: word

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

Extends: OfficeExtension.ClientObject

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Sets a comment on the selected content.
await Word.run(async (context) => {
  const text = $("#comment-text")
    .val()
    .toString();
  const comment: Word.Comment = context.document.getSelection().insertComment(text);

  // Load object to log in the console.
  comment.load();
  await context.sync();

  console.log("Comment inserted:", comment);
});

Свойства

authorEmail	Получает электронную почту автора примечания.
authorName	Получает имя автора примечания.
content	Указывает содержимое комментария в виде обычного текста.
contentRange	Указывает диапазон содержимого комментария.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
creationDate	Возвращает дату создания комментария.
id	Возвращает идентификатор комментария.
replies	Возвращает коллекцию объектов ответа, связанных с комментарием.
resolved	Указывает состояние потока комментариев. Если задано значение true, поток комментариев разрешается. Получение значения true означает, что поток комментариев разрешен.

Методы

delete()	Удаляет комментарий и его ответы.
getRange()	Возвращает диапазон в основном документе, в котором находится комментарий.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
reply(replyText)	Добавляет новый ответ в конец потока комментариев.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.Comment` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Word.Interfaces.CommentData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Edits the first active comment in the selected content.
await Word.run(async (context) => {
  const text = $("#edit-comment-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) {
    console.warn("No active comment was found in the selection, so couldn't edit.");
    return;
  }

  firstActiveComment.content = text;

  // Load object to log in the console.
  firstActiveComment.load();
  await context.sync();

  console.log("Comment content changed:", firstActiveComment);
});

contentRange

Указывает диапазон содержимого комментария.

contentRange: Word.CommentContentRange;

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

Word.CommentContentRange

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
  const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
  comment.load("contentRange");
  const range: Word.Range = comment.getRange();
  range.load("text");
  await context.sync();

  if (comment.isNullObject) {
    console.warn("No comments in the selection, so no range to get.");
    return;
  }

  console.log(`Comment location: ${range.text}`);
  const contentRange: Word.CommentContentRange = comment.contentRange;
  console.log("Comment content range:", contentRange);
});

context

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

context: RequestContext;

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

Word.RequestContext

creationDate

Возвращает дату создания комментария.

readonly creationDate: Date;

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

Date

id

Возвращает идентификатор комментария.

readonly id: string;

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

string

replies

Возвращает коллекцию объектов ответа, связанных с комментарием.

readonly replies: Word.CommentReplyCollection;

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

Word.CommentReplyCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Gets the replies to the first comment in the selected content.
await Word.run(async (context) => {
  const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
  comment.load("replies");
  await context.sync();

  if (comment.isNullObject) {
    console.warn("No comments in the selection, so no replies to get.");
    return;
  }

  const replies: Word.CommentReplyCollection = comment.replies;
  console.log("Replies to the first comment:", replies);
});

resolved

Указывает состояние потока комментариев. Если задано значение true, поток комментариев разрешается. Получение значения true означает, что поток комментариев разрешен.

resolved: boolean;

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

boolean

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Toggles Resolved status of the first comment in the selected content.
await Word.run(async (context) => {
  const comment: Word.Comment = context.document
    .getSelection()
    .getComments()
    .getFirstOrNullObject();
  comment.load("resolved");
  await context.sync();

  if (comment.isNullObject) {
    console.warn("No comments in the selection, so nothing to toggle.");
    return;
  }

  // Toggle resolved status.
  // If the comment is active, set as resolved.
  // If it's resolved, set resolved to false.
  const resolvedBefore = comment.resolved;
  console.log(`Comment Resolved status (before): ${resolvedBefore}`);
  comment.resolved = !resolvedBefore;
  comment.load("resolved");
  await context.sync();

  console.log(`Comment Resolved status (after): ${comment.resolved}`);
});

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

delete()

Удаляет комментарий и его ответы.

delete(): void;

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Deletes the first comment in the selected content.
await Word.run(async (context) => {
  const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
  comment.delete();
  await context.sync();

  if (comment.isNullObject) {
    console.warn("No comments in the selection, so nothing to delete.");
    return;
  }

  console.log("Comment deleted.");
});

getRange()

Возвращает диапазон в основном документе, в котором находится комментарий.

getRange(): Word.Range;

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

Word.Range

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
  const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
  comment.load("contentRange");
  const range: Word.Range = comment.getRange();
  range.load("text");
  await context.sync();

  if (comment.isNullObject) {
    console.warn("No comments in the selection, so no range to get.");
    return;
  }

  console.log(`Comment location: ${range.text}`);
  const contentRange: Word.CommentContentRange = comment.contentRange;
  console.log("Comment content range:", contentRange);
});

load(options)

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

load(options?: Word.Interfaces.CommentLoadOptions): Word.Comment;

Параметры

options: Word.Interfaces.CommentLoadOptions

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

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

Word.Comment

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Word.Comment

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Word.Comment

reply(replyText)

Добавляет новый ответ в конец потока комментариев.

reply(replyText: string): Word.CommentReply;

Параметры

replyText: string

Обязательно. Текст ответа.

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

Word.CommentReply

Примеры

// 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.");
  }
});

set(properties, options)

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

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

Параметры

properties: Word.Interfaces.CommentUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.Comment): void;

Параметры

properties: Word.Comment

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

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.Comment объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.CommentData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Word.Interfaces.CommentData;

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

Word.Interfaces.CommentData

track()

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

track(): Word.Comment;

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

Word.Comment

untrack()

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

untrack(): Word.Comment;

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

Word.Comment

Поделиться через

Word.Comment class

Комментарии

Примеры

Свойства

Методы

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

authorEmail

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

Комментарии

authorName

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

Комментарии

content

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

Комментарии

Примеры

contentRange

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

Комментарии

Примеры

context

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

creationDate

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

Комментарии

id

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

Комментарии

replies

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

Комментарии

Примеры

resolved

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

Комментарии

Примеры

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

delete()

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

Комментарии

Примеры

getRange()

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

Комментарии

Примеры

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

reply(replyText)

Параметры

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

Комментарии

Примеры

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

track()

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

untrack()

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

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

Дополнительные ресурсы