Word.DocumentExportAsFixedFormatOptions interface
注意
この 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();
});
プロパティ
| bitmap |
指定した場合は、不足しているフォントをビットマップ化するかどうかを指定します。 既定値は |
| create |
指定した場合は、ブックマーク作成モードを指定します。 既定値は |
| document |
指定した場合は、ドキュメント構造タグを含めるかどうかを指定します。 既定値は |
| fixed |
指定した場合は、拡張クラス ポインターを指定します。 既定値は |
| from | 指定する場合は、開始ページ番号を指定します。 既定値は |
| include |
指定した場合は、ドキュメント プロパティを含めるかどうかを指定します。 既定値は |
| item | 指定した場合は、エクスポートする項目を指定します。 既定値は |
| keep |
指定した場合は、Information Rights Management (IRM) 設定を保持するかどうかを指定します。 既定値は |
| open |
指定した場合は、エクスポート後にファイルを開くかどうかを指定します。 既定値は |
| optimize |
指定した場合は、エクスポートの最適化ターゲットを指定します。 既定値は |
| range | 指定した場合は、エクスポートする範囲を指定します。 既定値は |
| to | 指定された場合は、終了ページ番号を指定します。 既定値は、文書の最後のページです。 |
| use |
指定する場合は、ISO 19005-1 コンプライアンスを使用するかどうかを指定します。 既定値は |
プロパティの詳細
bitmapMissingFonts
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、不足しているフォントをビットマップ化するかどうかを指定します。 既定値は true です。
bitmapMissingFonts?: boolean;プロパティ値
boolean
注釈
createBookmarks
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、ブックマーク作成モードを指定します。 既定値は none です。
createBookmarks?: Word.ExportCreateBookmarks | "None" | "Headings" | "WordBookmarks";プロパティ値
Word.ExportCreateBookmarks | "None" | "Headings" | "WordBookmarks"
注釈
documentStructureTags
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、ドキュメント構造タグを含めるかどうかを指定します。 既定値は true です。
documentStructureTags?: boolean;プロパティ値
boolean
注釈
fixedFormatExtensionClassPointer
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、拡張クラス ポインターを指定します。 既定値は null です。
fixedFormatExtensionClassPointer?: any;プロパティ値
any
注釈
from
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定する場合は、開始ページ番号を指定します。 既定値は 1 です。
from?: number;プロパティ値
number
注釈
includeDocProps
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、ドキュメント プロパティを含めるかどうかを指定します。 既定値は true です。
includeDocProps?: boolean;プロパティ値
boolean
注釈
item
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、エクスポートする項目を指定します。 既定値は documentContent です。
item?: Word.ExportItem | "DocumentContent" | "DocumentWithMarkup";プロパティ値
Word.ExportItem | "DocumentContent" | "DocumentWithMarkup"
注釈
keepInformationRightsManagement
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、Information Rights Management (IRM) 設定を保持するかどうかを指定します。 既定値は true です。
keepInformationRightsManagement?: boolean;プロパティ値
boolean
注釈
openAfterExport
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、エクスポート後にファイルを開くかどうかを指定します。 既定値は false です。
openAfterExport?: boolean;プロパティ値
boolean
注釈
optimizeFor
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、エクスポートの最適化ターゲットを指定します。 既定値は print です。
optimizeFor?: Word.ExportOptimizeFor | "Print" | "OnScreen";プロパティ値
Word.ExportOptimizeFor | "Print" | "OnScreen"
注釈
range
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定した場合は、エクスポートする範囲を指定します。 既定値は allDocument です。
range?: Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo";プロパティ値
Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo"
注釈
to
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定された場合は、終了ページ番号を指定します。 既定値は、文書の最後のページです。
to?: number;プロパティ値
number
注釈
useIso19005_1
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
指定する場合は、ISO 19005-1 コンプライアンスを使用するかどうかを指定します。 既定値は false です。
useIso19005_1?: boolean;プロパティ値
boolean