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 = $("#filePath")
    .val()
    .toString();
  // 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 добавляет документ в список недавно использовавшихся файлов в меню Файл. Значение по умолчанию — True.
authorName	Имя рецензента, связанное с различиями, вызванными сравнением. Если значение не указано, по умолчанию используется имя автора измененного документа или строка "Сравнение", если сведения об авторе отсутствуют.
compareTarget	Целевой документ для сравнения. Значение по умолчанию — CompareTargetCurrent.
detectFormatChanges	Значение true (по умолчанию) для сравнения для включения обнаружения изменений формата.
ignoreAllComparisonWarnings	Значение True сравнивает документы, не уведомляя пользователя о проблемах. Значение по умолчанию — False.
removeDateAndTime	Значение True удаляет данные меток даты и времени из отслеживаемых изменений в возвращенном объекте Document. Значение по умолчанию — False.
removePersonalInformation	Значение True удаляет все сведения о пользователе из комментариев, редакций и диалогового окна свойств в возвращенном объекте Document. Значение по умолчанию — False.

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

addToRecentFiles

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

addToRecentFiles?: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

authorName

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

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

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

ignoreAllComparisonWarnings?: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

removeDateAndTime

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

removeDateAndTime?: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

removePersonalInformation

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

removePersonalInformation?: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.1 ]