Word.DocumentCompareOptions interface

Пакет:

word

Указывает параметры для включения в операцию сравнения документов.

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

Примеры

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

Свойства

addToRecentFiles	Если этот параметр указан, указывает, следует ли добавить документ в список недавно использовавшихся файлов в меню Файл . Значение по умолчанию — true.
authorName	Если это указано, указывает имя рецензента, связанное с различиями, созданными при сравнении. Если значение не указано, по умолчанию используется имя автора измененного документа или строка Comparison , если сведения об авторе отсутствуют.
compareTarget	Если этот параметр указан, указывает целевой документ для сравнения. Значение по умолчанию — compareTargetCurrent.
detectFormatChanges	Если этот параметр указан, указывает, должно ли сравнение включать обнаружение изменений формата. Значение по умолчанию — true.
ignoreAllComparisonWarnings	Если этот параметр указан, указывает, следует ли сравнивать документы, не уведомляя пользователя о проблемах. Значение по умолчанию — false.
removeDateAndTime	Если этот параметр указан, указывает, следует ли удалять данные метки даты и времени из отслеживаемых изменений в возвращаемом объекте Document . Значение по умолчанию — false.
removePersonalInformation	При указании указывает, следует ли удалять все сведения о пользователе из комментариев, редакций и диалогового окна свойств в возвращаемом объекте Document . Значение по умолчанию — false.

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

addToRecentFiles

Если этот параметр указан, указывает, следует ли добавить документ в список недавно использовавшихся файлов в меню Файл . Значение по умолчанию — true.

addToRecentFiles?: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

authorName

Если это указано, указывает имя рецензента, связанное с различиями, созданными при сравнении. Если значение не указано, по умолчанию используется имя автора измененного документа или строка Comparison , если сведения об авторе отсутствуют.

authorName?: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

compareTarget

Если этот параметр указан, указывает целевой документ для сравнения. Значение по умолчанию — compareTargetCurrent.

compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew";

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

Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

detectFormatChanges

Если этот параметр указан, указывает, должно ли сравнение включать обнаружение изменений формата. Значение по умолчанию — true.

detectFormatChanges?: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

ignoreAllComparisonWarnings

Если этот параметр указан, указывает, следует ли сравнивать документы, не уведомляя пользователя о проблемах. Значение по умолчанию — false.

ignoreAllComparisonWarnings?: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

removeDateAndTime

Если этот параметр указан, указывает, следует ли удалять данные метки даты и времени из отслеживаемых изменений в возвращаемом объекте Document . Значение по умолчанию — false.

removeDateAndTime?: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

removePersonalInformation

При указании указывает, следует ли удалять все сведения о пользователе из комментариев, редакций и диалогового окна свойств в возвращаемом объекте Document . Значение по умолчанию — false.

removePersonalInformation?: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.1 ]