Word.DocumentExportAsFixedFormatOptions interface

Пакет:
word

Примечание

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

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

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)

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

Примеры

// 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) => {
  const document: Word.Document = context.document;

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

  // If a file with the same name already exists at the default location, it's silently overwritten.
  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 (только предварительная версия)

createBookmarks

Примечание

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

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

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

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

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

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)

documentStructureTags

Примечание

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

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

documentStructureTags?: boolean;

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

boolean

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)

fixedFormatExtensionClassPointer

Примечание

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

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

fixedFormatExtensionClassPointer?: any;

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

any

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)

from

Примечание

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

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

from?: number;

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

number

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)

includeDocProps

Примечание

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

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

includeDocProps?: boolean;

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

boolean

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)

item

Примечание

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

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

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

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

Word.ExportItem | "DocumentContent" | "DocumentWithMarkup"

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)

keepInformationRightsManagement

Примечание

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

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

keepInformationRightsManagement?: boolean;

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

boolean

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)

openAfterExport

Примечание

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

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

openAfterExport?: boolean;

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

boolean

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)

optimizeFor

Примечание

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

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

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

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

Word.ExportOptimizeFor | "Print" | "OnScreen"

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)

range

Примечание

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

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

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

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

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

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)

to

Примечание

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

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

to?: number;

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

number

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)

useIso19005_1

Примечание

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

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

useIso19005_1?: boolean;

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

boolean

Комментарии

Набор API: Бета-версия WordApi (только предварительная версия)