Word.DocumentExportAsFixedFormatOptions interface

包:
word

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

为 Document.exportAsFixedFormat 方法提供配置选项。

注解

API 集：WordApi BETA (仅预览版)

使用方

示例

// 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 (仅预览版)