Word.DocumentExportAsFixedFormatOptions interface

Пакет:

word

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Предоставляет параметры конфигурации для метода Document.exportAsFixedFormat .

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

Используется

• Word. Документ: exportAsFixedFormat

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/export.yaml

await Word.run(async (context) => {
  // Choose whether the exported PDF uses Word headings, named bookmarks, or neither.
  const bookmarkMode = (document.getElementById("bookmark-mode") as HTMLSelectElement).value;
  let createBookmarks: Word.ExportCreateBookmarks;

  switch (bookmarkMode) {
    case "Headings":
      createBookmarks = Word.ExportCreateBookmarks.headings;
      break;
    case "WordBookmarks":
      createBookmarks = Word.ExportCreateBookmarks.wordBookmarks;
      break;
    default:
      createBookmarks = Word.ExportCreateBookmarks.none;
      break;
  }

  // Export the current document as a PDF saved in your default location, usually Documents.
  const filename = `exported-doc-${bookmarkMode}-${getCurrentDate()}.pdf`;
  console.log(`File name: ${filename}`);
  const options: Word.DocumentExportAsFixedFormatOptions = {
    item: Word.ExportItem.documentContent,
    openAfterExport: true,
    optimizeFor: Word.ExportOptimizeFor.onScreen,
    createBookmarks: createBookmarks,
  };

  // If a file with the same name already exists at the default location, it's silently overwritten.
  context.document.exportAsFixedFormat(filename, Word.ExportFormat.pdf, options);

  await context.sync();
});

Свойства

bitmapMissingFonts	Если указано, указывает, следует ли использовать растровое изображение отсутствующих шрифтов. Значение по умолчанию: true.
createBookmarks	Если указано, указывает режим создания закладки. Значение по умолчанию: none.
documentStructureTags	Если дано, указывает, следует ли включать теги структуры документа. Значение по умолчанию: true.
fixedFormatExtensionClassPointer	Указывает указатель на класс расширения (если он указан). Значение по умолчанию: null.
from	Если указан, указывает начальный номер страницы. Значение по умолчанию: 1.
includeDocProps	Если указано, указывает, следует ли включать свойства документа. Значение по умолчанию: true.
item	Если дано, указывается элемент для экспорта. Значение по умолчанию: documentContent.
keepInformationRightsManagement	Если указано, указывает, следует ли сохранить параметры управления правами на доступ к данным (IRM). Значение по умолчанию: true.
openAfterExport	Если указано, указывает, следует ли открыть файл после экспорта. Значение по умолчанию: false.
optimizeFor	Указывает цель оптимизации для экспорта (если указана). Значение по умолчанию: print.
range	Если дано, укажите диапазон для экспорта. Значение по умолчанию: allDocument.
to	Если указан, указывает номер страницы завершения. Значение по умолчанию — последняя страница документа.
useIso19005_1	Если указано, указывает, следует ли использовать совместимость с ISO 19005-1. Значение по умолчанию: false.

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

bitmapMissingFonts

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

bitmapMissingFonts?: boolean;

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

boolean

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

createBookmarks

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Если указано, указывает режим создания закладки. Значение по умолчанию: none.

createBookmarks?: Word.ExportCreateBookmarks | "None" | "Headings" | "WordBookmarks";

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

Word.ExportCreateBookmarks | "None" | "Headings" | "WordBookmarks"

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

documentStructureTags

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Если дано, указывает, следует ли включать теги структуры документа. Значение по умолчанию: true.

documentStructureTags?: boolean;

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

boolean

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

fixedFormatExtensionClassPointer

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Указывает указатель на класс расширения (если он указан). Значение по умолчанию: null.

fixedFormatExtensionClassPointer?: any;

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

any

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

from

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Если указан, указывает начальный номер страницы. Значение по умолчанию: 1.

from?: number;

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

number

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

includeDocProps

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Если указано, указывает, следует ли включать свойства документа. Значение по умолчанию: true.

includeDocProps?: boolean;

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

boolean

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

item

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

item?: Word.ExportItem | "DocumentContent" | "DocumentWithMarkup";

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

Word.ExportItem | "DocumentContent" | "DocumentWithMarkup"

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

keepInformationRightsManagement

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Если указано, указывает, следует ли сохранить параметры управления правами на доступ к данным (IRM). Значение по умолчанию: true.

keepInformationRightsManagement?: boolean;

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

boolean

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

openAfterExport

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

openAfterExport?: boolean;

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

boolean

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

optimizeFor

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Указывает цель оптимизации для экспорта (если указана). Значение по умолчанию: print.

optimizeFor?: Word.ExportOptimizeFor | "Print" | "OnScreen";

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

Word.ExportOptimizeFor | "Print" | "OnScreen"

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

range

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Если дано, укажите диапазон для экспорта. Значение по умолчанию: allDocument.

range?: Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo";

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

Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo"

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

to

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

to?: number;

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

number

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

useIso19005_1

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Если указано, указывает, следует ли использовать совместимость с ISO 19005-1. Значение по умолчанию: false.

useIso19005_1?: boolean;

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

boolean

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)