Word.DocumentCompareOptions interface
Определяет параметры, которые должны включаться в операцию сравнения документов.
Комментарии
Используется
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/compare-documents.yaml
// Compares the current document with a specified external document.
await Word.run(async (context) => {
// Absolute path of an online or local document.
const filePath = (document.getElementById("filePath") as HTMLInputElement).value;
// Options that configure the compare operation.
const options: Word.DocumentCompareOptions = {
compareTarget: Word.CompareTarget.compareTargetCurrent,
detectFormatChanges: false
// Other options you choose...
};
context.document.compare(filePath, options);
await context.sync();
console.log("Differences shown in the current document.");
});
Свойства
| add |
Если указано, указывает, следует ли добавить документ в список недавно использовавшихся файлов в меню Файл . Значение по умолчанию: |
| author |
Если указано, укажите имя рецензента, связанное с различиями, полученными в результате сравнения. Если не указано, по умолчанию значением по умолчанию является имя автора исправленного документа или строка |
| compare |
Если указано, указывается целевой документ для сравнения. Значение по умолчанию: |
| detect |
Если указано, указывает, должно ли сравнение включать обнаружение изменений формата. Значение по умолчанию: |
| ignore |
Если указано, указывает, следует ли сравнивать документы без уведомления пользователя о проблемах. Значение по умолчанию: |
| remove |
Указывает, следует ли удалять сведения о метке даты и времени из отслеживаемых изменений в возвращенном |
| remove |
Указывает, следует ли удалить все сведения о пользователе из комментариев, исправлений и диалогового окна свойств в возвращаемом |
Сведения о свойстве
addToRecentFiles
Если указано, указывает, следует ли добавить документ в список недавно использовавшихся файлов в меню Файл . Значение по умолчанию: true.
addToRecentFiles?: boolean;Значение свойства
boolean
Комментарии
authorName
Если указано, укажите имя рецензента, связанное с различиями, полученными в результате сравнения. Если не указано, по умолчанию значением по умолчанию является имя автора исправленного документа или строка Comparison , если сведения об авторе отсутствуют.
authorName?: string;Значение свойства
string
Комментарии
compareTarget
Если указано, указывается целевой документ для сравнения. Значение по умолчанию: compareTargetCurrent.
compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew";Значение свойства
Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"
Комментарии
detectFormatChanges
Если указано, указывает, должно ли сравнение включать обнаружение изменений формата. Значение по умолчанию: true.
detectFormatChanges?: boolean;Значение свойства
boolean
Комментарии
ignoreAllComparisonWarnings
Если указано, указывает, следует ли сравнивать документы без уведомления пользователя о проблемах. Значение по умолчанию: false.
ignoreAllComparisonWarnings?: boolean;Значение свойства
boolean
Комментарии
removeDateAndTime
Указывает, следует ли удалять сведения о метке даты и времени из отслеживаемых изменений в возвращенном Document объекте. Значение по умолчанию: false.
removeDateAndTime?: boolean;Значение свойства
boolean
Комментарии
removePersonalInformation
Указывает, следует ли удалить все сведения о пользователе из комментариев, исправлений и диалогового окна свойств в возвращаемом Document объекте (если дано). Значение по умолчанию: false.
removePersonalInformation?: boolean;Значение свойства
boolean