Word.DocumentExportAsFixedFormatOptions interface

Paquet:
word

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Fournit des options de configuration pour la méthode Document.exportAsFixedFormat .

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

Utilisateur

Exemples

// 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();
});

Propriétés

bitmapMissingFonts

Le cas échéant, spécifie s’il faut bitmapper les polices manquantes. La valeur par défaut est true.
createBookmarks

S’il est fourni, spécifie le mode de création de signets. La valeur par défaut est none.
documentStructureTags

Le cas échéant, indique s’il faut inclure les balises de structure de document. La valeur par défaut est true.
fixedFormatExtensionClassPointer

S’il est fourni, spécifie le pointeur de classe d’extension. La valeur par défaut est null.
from

S’il est fourni, spécifie le numéro de la première page. La valeur par défaut est 1.
includeDocProps

Si ces informations sont fournies, spécifie s’il faut inclure les propriétés du document. La valeur par défaut est true.
item

S’il est fourni, spécifie l’élément à exporter. La valeur par défaut est documentContent.
keepInformationRightsManagement

Le cas échéant, indique s’il faut conserver les paramètres de Gestion des droits relatifs à l’information (IRM). La valeur par défaut est true.
openAfterExport

S’il est fourni, spécifie s’il faut ouvrir le fichier après l’exportation. La valeur par défaut est false.
optimizeFor

S’il est fourni, spécifie la cible d’optimisation pour l’exportation. La valeur par défaut est print.
range

Si elle est fournie, spécifie la plage à exporter. La valeur par défaut est allDocument.
to

S’il est fourni, spécifie le numéro de page de fin. La valeur par défaut est la dernière page du document.
useIso19005_1

Le cas échéant, spécifie s’il faut utiliser la conformité ISO 19005-1. La valeur par défaut est false.

Détails de la propriété

bitmapMissingFonts

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Le cas échéant, spécifie s’il faut bitmapper les polices manquantes. La valeur par défaut est true.

bitmapMissingFonts?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

createBookmarks

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

S’il est fourni, spécifie le mode de création de signets. La valeur par défaut est none.

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

Valeur de propriété

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

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

documentStructureTags

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Le cas échéant, indique s’il faut inclure les balises de structure de document. La valeur par défaut est true.

documentStructureTags?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

fixedFormatExtensionClassPointer

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

S’il est fourni, spécifie le pointeur de classe d’extension. La valeur par défaut est null.

fixedFormatExtensionClassPointer?: any;

Valeur de propriété

any

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

from

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

S’il est fourni, spécifie le numéro de la première page. La valeur par défaut est 1.

from?: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

includeDocProps

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Si ces informations sont fournies, spécifie s’il faut inclure les propriétés du document. La valeur par défaut est true.

includeDocProps?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

item

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

S’il est fourni, spécifie l’élément à exporter. La valeur par défaut est documentContent.

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

Valeur de propriété

Word.ExportItem | "DocumentContent" | "DocumentWithMarkup"

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

keepInformationRightsManagement

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Le cas échéant, indique s’il faut conserver les paramètres de Gestion des droits relatifs à l’information (IRM). La valeur par défaut est true.

keepInformationRightsManagement?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

openAfterExport

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

S’il est fourni, spécifie s’il faut ouvrir le fichier après l’exportation. La valeur par défaut est false.

openAfterExport?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

optimizeFor

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

S’il est fourni, spécifie la cible d’optimisation pour l’exportation. La valeur par défaut est print.

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

Valeur de propriété

Word.ExportOptimizeFor | "Print" | "OnScreen"

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

range

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Si elle est fournie, spécifie la plage à exporter. La valeur par défaut est allDocument.

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

Valeur de propriété

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

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

to

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

S’il est fourni, spécifie le numéro de page de fin. La valeur par défaut est la dernière page du document.

to?: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

useIso19005_1

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Le cas échéant, spécifie s’il faut utiliser la conformité ISO 19005-1. La valeur par défaut est false.

useIso19005_1?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)