Word.DocumentExportAsFixedFormatOptions interface
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Enthält Konfigurationsoptionen für die Document.exportAsFixedFormat-Methode .
Hinweise
API-Satz: WordApi BETA (NUR VORSCHAU)
Verwendet von
Beispiele
// 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();
});
Eigenschaften
| bitmap |
Gibt an, ob fehlende Schriftarten bitmap werden sollen. Der Standardwert ist |
| create |
Gibt (falls angegeben) den Lesezeichenerstellungsmodus an. Der Standardwert ist |
| document |
Gibt (falls angegeben) an, ob Dokumentstruktur-Tags eingeschlossen werden sollen. Der Standardwert ist |
| fixed |
Gibt (falls angegeben) den Erweiterungsklassenzeiger an. Der Standardwert ist |
| from | Falls angegeben, wird die Anfangsseitenzahl angegeben. Der Standardwert ist |
| include |
Gibt an, ob Dokumenteigenschaften einbezogen werden sollen. Der Standardwert ist |
| item | Falls angegeben, wird das zu exportierende Element angegeben. Der Standardwert ist |
| keep |
Gibt (falls angegeben) an, ob die Einstellungen für Information Rights Management (IRM) beibehalten werden sollen. Der Standardwert ist |
| open |
Gibt (falls angegeben) an, ob die Datei nach dem Export geöffnet werden soll. Der Standardwert ist |
| optimize |
Falls angegeben, wird das Optimierungsziel für den Export angegeben. Der Standardwert ist |
| range | Falls angegeben, wird der zu exportierende Bereich angegeben. Der Standardwert ist |
| to | Gibt (falls angegeben) die Endseitenzahl an. Der Standardwert ist die letzte Seite des Dokuments. |
| use |
Gibt an, ob die ISO 19005-1-Konformität verwendet werden soll. Der Standardwert ist |
Details zur Eigenschaft
bitmapMissingFonts
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt an, ob fehlende Schriftarten bitmap werden sollen. Der Standardwert ist true.
bitmapMissingFonts?: boolean;Eigenschaftswert
boolean
Hinweise
createBookmarks
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt (falls angegeben) den Lesezeichenerstellungsmodus an. Der Standardwert ist none.
createBookmarks?: Word.ExportCreateBookmarks | "None" | "Headings" | "WordBookmarks";Eigenschaftswert
Word.ExportCreateBookmarks | "None" | "Headings" | "WordBookmarks"
Hinweise
documentStructureTags
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt (falls angegeben) an, ob Dokumentstruktur-Tags eingeschlossen werden sollen. Der Standardwert ist true.
documentStructureTags?: boolean;Eigenschaftswert
boolean
Hinweise
fixedFormatExtensionClassPointer
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt (falls angegeben) den Erweiterungsklassenzeiger an. Der Standardwert ist null.
fixedFormatExtensionClassPointer?: any;Eigenschaftswert
any
Hinweise
from
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Falls angegeben, wird die Anfangsseitenzahl angegeben. Der Standardwert ist 1.
from?: number;Eigenschaftswert
number
Hinweise
includeDocProps
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt an, ob Dokumenteigenschaften einbezogen werden sollen. Der Standardwert ist true.
includeDocProps?: boolean;Eigenschaftswert
boolean
Hinweise
item
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Falls angegeben, wird das zu exportierende Element angegeben. Der Standardwert ist documentContent.
item?: Word.ExportItem | "DocumentContent" | "DocumentWithMarkup";Eigenschaftswert
Word.ExportItem | "DocumentContent" | "DocumentWithMarkup"
Hinweise
keepInformationRightsManagement
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt (falls angegeben) an, ob die Einstellungen für Information Rights Management (IRM) beibehalten werden sollen. Der Standardwert ist true.
keepInformationRightsManagement?: boolean;Eigenschaftswert
boolean
Hinweise
openAfterExport
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt (falls angegeben) an, ob die Datei nach dem Export geöffnet werden soll. Der Standardwert ist false.
openAfterExport?: boolean;Eigenschaftswert
boolean
Hinweise
optimizeFor
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Falls angegeben, wird das Optimierungsziel für den Export angegeben. Der Standardwert ist print.
optimizeFor?: Word.ExportOptimizeFor | "Print" | "OnScreen";Eigenschaftswert
Word.ExportOptimizeFor | "Print" | "OnScreen"
Hinweise
range
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Falls angegeben, wird der zu exportierende Bereich angegeben. Der Standardwert ist allDocument.
range?: Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo";Eigenschaftswert
Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo"
Hinweise
to
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt (falls angegeben) die Endseitenzahl an. Der Standardwert ist die letzte Seite des Dokuments.
to?: number;Eigenschaftswert
number
Hinweise
useIso19005_1
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt an, ob die ISO 19005-1-Konformität verwendet werden soll. Der Standardwert ist false.
useIso19005_1?: boolean;Eigenschaftswert
boolean