Word.TrackedChangeCollection class
Содержит коллекцию Word. Объекты TrackedChange.
- Extends
Комментарии
Примеры
// 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: Word.Body = context.document.body;
const trackedChanges: Word.TrackedChangeCollection = body.getTrackedChanges();
const trackedChange: Word.TrackedChange = trackedChanges.getFirst();
await context.sync();
const range: Word.Range = trackedChange.getRange();
range.load();
await context.sync();
console.log("range.text: " + range.text);
});
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| accept |
Принимает все отслеживаемые изменения в коллекции. |
| get |
Возвращает первое значение TrackedChange в этой коллекции. Выдает ошибку, |
| get |
Возвращает первое значение TrackedChange в этой коллекции. Если коллекция пуста, то этот метод вернет объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| reject |
Отклоняет все отслеживаемые изменения в коллекции. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Word.TrackedChange[];Значение свойства
Сведения о методе
acceptAll()
Принимает все отслеживаемые изменения в коллекции.
acceptAll(): void;Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-tracked-changes.yaml
// Accepts all tracked changes.
await Word.run(async (context) => {
const body: Word.Body = context.document.body;
const trackedChanges: Word.TrackedChangeCollection = body.getTrackedChanges();
trackedChanges.acceptAll();
console.log("Accepted all tracked changes.");
});
getFirst()
Возвращает первое значение TrackedChange в этой коллекции. Выдает ошибку, ItemNotFound если эта коллекция пуста.
getFirst(): Word.TrackedChange;Возвращаемое значение
Комментарии
Примеры
// 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: Word.Body = context.document.body;
const trackedChanges: Word.TrackedChangeCollection = body.getTrackedChanges();
const trackedChange: Word.TrackedChange = trackedChanges.getFirst();
await context.sync();
const range: Word.Range = trackedChange.getRange();
range.load();
await context.sync();
console.log("range.text: " + range.text);
});
getFirstOrNullObject()
Возвращает первое значение TrackedChange в этой коллекции. Если коллекция пуста, то этот метод вернет объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getFirstOrNullObject(): Word.TrackedChange;Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.TrackedChangeCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TrackedChangeCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
rejectAll()
Отклоняет все отслеживаемые изменения в коллекции.
rejectAll(): void;Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-tracked-changes.yaml
// Rejects all tracked changes.
await Word.run(async (context) => {
const body: Word.Body = context.document.body;
const trackedChanges: Word.TrackedChangeCollection = body.getTrackedChanges();
trackedChanges.rejectAll();
console.log("Rejected all tracked changes.");
});
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.TrackedChangeCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.TrackedChangeCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): Word.Interfaces.TrackedChangeCollectionData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.TrackedChangeCollection;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.TrackedChangeCollection;Возвращаемое значение
Office Add-ins