Word.TrackedChange class
Представляет отслеживаемые изменения в документе Word.
- Extends
Комментарии
Используется
Примеры
// 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: Word.Body = context.document.body;
const trackedChanges: Word.TrackedChangeCollection = body.getTrackedChanges();
await context.sync();
const trackedChange: Word.TrackedChange = trackedChanges.getFirst();
await context.sync();
const nextTrackedChange: Word.TrackedChange = trackedChange.getNext();
await context.sync();
nextTrackedChange.load(["author", "date", "text", "type"]);
await context.sync();
console.log(nextTrackedChange);
});
Свойства
| author | Получает автора отслеживаемого изменения. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| date | Получает дату отслеживаемого изменения. |
| text | Получает текст отслеживаемых изменений. |
| type | Получает тип отслеживаемых изменений. |
Методы
| accept() | Принимает отслеживаемые изменения. |
| get |
Получает следующее отслеживаемое изменение. Выдает ошибку, |
| get |
Получает следующее отслеживаемое изменение. Если это отслеживаемое изменение является последним, то этот метод вернет объект со свойством |
| get |
Получает диапазон отслеживаемых изменений. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| reject() | Отклоняет отслеживаемое изменение. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
Сведения о свойстве
author
Получает автора отслеживаемого изменения.
readonly author: string;Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
date
Получает дату отслеживаемого изменения.
readonly date: Date;Значение свойства
Date
Комментарии
text
Получает текст отслеживаемых изменений.
readonly text: string;Значение свойства
string
Комментарии
type
Получает тип отслеживаемых изменений.
readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted";Значение свойства
Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"
Комментарии
Сведения о методе
accept()
Принимает отслеживаемые изменения.
accept(): void;Возвращаемое значение
void
Комментарии
Примеры
// 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: Word.Body = context.document.body;
const trackedChanges: Word.TrackedChangeCollection = body.getTrackedChanges();
const trackedChange: Word.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;Возвращаемое значение
Комментарии
Примеры
// 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: Word.Body = context.document.body;
const trackedChanges: Word.TrackedChangeCollection = body.getTrackedChanges();
await context.sync();
const trackedChange: Word.TrackedChange = trackedChanges.getFirst();
await context.sync();
const nextTrackedChange: Word.TrackedChange = trackedChange.getNext();
await context.sync();
nextTrackedChange.load(["author", "date", "text", "type"]);
await context.sync();
console.log(nextTrackedChange);
});
getNextOrNullObject()
Получает следующее отслеживаемое изменение. Если это отслеживаемое изменение является последним, то этот метод вернет объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getNextOrNullObject(): Word.TrackedChange;Возвращаемое значение
Комментарии
getRange(rangeLocation)
Получает диапазон отслеживаемых изменений.
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;Параметры
Необязательный параметр. Указывает часть отслеживаемого изменения, для которой нужно получить диапазон. Если этот параметр не задан, возвращается весь диапазон отслеживаемых изменений.
Возвращаемое значение
Комментарии
Примеры
// 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);
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.TrackedChange;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TrackedChange;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
reject()
Отклоняет отслеживаемое изменение.
reject(): void;Возвращаемое значение
void
Комментарии
Примеры
// 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: Word.Body = context.document.body;
const trackedChanges: Word.TrackedChangeCollection = body.getTrackedChanges();
const trackedChange: Word.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;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
track(): Word.TrackedChange;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): Word.TrackedChange;