Share via

Word.TrackedChange class

  • Ссылка
Пакет:
word

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApi 1.6 ]

Свойства

author

Возвращает автора отслеживаемого изменения.
context

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

Возвращает дату отслеживаемого изменения.
text

Возвращает текст отслеживаемого изменения.
type

Возвращает тип отслеживаемого изменения.

Методы

accept()

Принимает отслеживаемое изменение.
getNext()

Возвращает следующее отслеживаемое изменение. Выдает ошибку, ItemNotFound если это отслеживаемое изменение является последним.
getNextOrNullObject()

Возвращает следующее отслеживаемое изменение. Если это отслеживаемое изменение является последним, то этот метод вернет объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getRange(rangeLocation)

Возвращает диапазон отслеживаемого изменения.
load(options)

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

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

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

Отклоняет отслеживаемое изменение.
toJSON()

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

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

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

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

author

Возвращает автора отслеживаемого изменения.

readonly author: string;

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

string

Комментарии

[ Набор API: WordApi 1.6 ]

context

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

context: RequestContext;

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

Word.RequestContext

date

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

readonly date: Date;

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

Date

Комментарии

[ Набор API: WordApi 1.6 ]

text

Возвращает текст отслеживаемого изменения.

readonly text: string;

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

string

Комментарии

[ Набор API: WordApi 1.6 ]

type

Возвращает тип отслеживаемого изменения.

readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted";

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

Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"

Комментарии

[ Набор API: WordApi 1.6 ]

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

accept()

Принимает отслеживаемое изменение.

accept(): void;

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

void

Комментарии

[ Набор API: WordApi 1.6 ]

Примеры

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

// Accepts the first tracked change.
await Word.run(async (context) => {
  const body = context.document.body;
  const trackedChanges = body.getTrackedChanges();
  const trackedChange = trackedChanges.getFirst();
  trackedChange.load();
  await context.sync();

  console.log("First tracked change:", trackedChange);
  trackedChange.accept();
  console.log("Accepted the first tracked change.");
});

getNext()

Возвращает следующее отслеживаемое изменение. Выдает ошибку, ItemNotFound если это отслеживаемое изменение является последним.

getNext(): Word.TrackedChange;

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

Word.TrackedChange

Комментарии

[ Набор API: WordApi 1.6 ]

Примеры

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

// Gets the next (second) tracked change.
await Word.run(async (context) => {
  const body = context.document.body;
  const trackedChanges = body.getTrackedChanges();
  await context.sync();

  const trackedChange = trackedChanges.getFirst();
  await context.sync();

  const nextTrackedChange = trackedChange.getNext();
  await context.sync();

  nextTrackedChange.load();
  await context.sync();

  console.log(nextTrackedChange);
});

getNextOrNullObject()

Возвращает следующее отслеживаемое изменение. Если это отслеживаемое изменение является последним, то этот метод вернет объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getNextOrNullObject(): Word.TrackedChange;

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

Word.TrackedChange

Комментарии

[ Набор API: WordApi 1.6 ]

getRange(rangeLocation)

Возвращает диапазон отслеживаемого изменения.

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;

Параметры

rangeLocation

whole | start | end | "Whole" | "Start" | "End"

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

Word.Range

Комментарии

[ Набор API: WordApi 1.6 ]

Примеры

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

// Gets the range of the first tracked change.
await Word.run(async (context) => {
  const body = context.document.body;
  const trackedChanges = body.getTrackedChanges();
  const trackedChange = trackedChanges.getFirst();
  await context.sync();

  const range = trackedChange.getRange();
  range.load();
  await context.sync();

  console.log("range.text: " + range.text);
});

load(options)

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

load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange;

Параметры

options
Word.Interfaces.TrackedChangeLoadOptions

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

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

Word.TrackedChange

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.TrackedChange

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.TrackedChange

reject()

Отклоняет отслеживаемое изменение.

reject(): void;

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

void

Комментарии

[ Набор API: WordApi 1.6 ]

Примеры

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

// Rejects the first tracked change.
await Word.run(async (context) => {
  const body = context.document.body;
  const trackedChanges = body.getTrackedChanges();
  const trackedChange = trackedChanges.getFirst();
  trackedChange.load();
  await context.sync();

  console.log("First tracked change:, trackedChange);
  trackedChange.reject();
  console.log("Rejected the first tracked change.");
});

toJSON()

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

toJSON(): Word.Interfaces.TrackedChangeData;

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

Word.Interfaces.TrackedChangeData

track()

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

track(): Word.TrackedChange;

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

Word.TrackedChange

untrack()

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

untrack(): Word.TrackedChange;

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

Word.TrackedChange