Word.Document class

Obtient le nom du thème actif et des options de mise en forme.

readonly activeTheme: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient le nom complet du thème actif.

readonly activeThemeDisplayName: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient la fenêtre active du document.

readonly activeWindow: Word.Window;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the first paragraph of each page.
  console.log("Getting first paragraph of each page...");

  // Get the active window.
  const activeWindow: Word.Window = context.document.activeWindow;
  activeWindow.load();

  // Get the active pane.
  const activePane: Word.Pane = activeWindow.activePane;
  activePane.load();

  // Get all pages.
  const pages: Word.PageCollection = activePane.pages;
  pages.load();

  await context.sync();

  // Get page index and paragraphs of each page.
  const pagesIndexes = [];
  const pagesNumberOfParagraphs = [];
  const pagesFirstParagraphText = [];
  for (let i = 0; i < pages.items.length; i++) {
    const page = pages.items[i];
    page.load("index");
    pagesIndexes.push(page);

    const paragraphs = page.getRange().paragraphs;
    paragraphs.load("items/length");
    pagesNumberOfParagraphs.push(paragraphs);

    const firstParagraph = paragraphs.getFirst();
    firstParagraph.load("text");
    pagesFirstParagraphText.push(firstParagraph);
  }

  await context.sync();

  for (let i = 0; i < pagesIndexes.length; i++) {
    console.log(`Page index: ${pagesIndexes[i].index}`);
    console.log(`Number of paragraphs: ${pagesNumberOfParagraphs[i].items.length}`);
    console.log("First paragraph's text:", pagesFirstParagraphText[i].text);
  }
});

Indique si Word chiffre les propriétés de fichier pour les documents protégés par mot de passe.

readonly areFilePropertiesPasswordEncrypted: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les erreurs grammaticales sont marquées par une ligne verte ondulée dans le document.

areGrammaticalErrorsShown: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie s’il faut utiliser les paramètres mathématiques par défaut lors de la création de nouvelles équations.

areMathDefaultsUsed: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie s’il faut désactiver les fonctionnalités introduites après une version spécifiée.

areNewerFeaturesDisabled: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si Microsoft Word souligne les fautes d’orthographe dans le document.

areSpellingErrorsShown: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les styles de ce document sont mis à jour pour correspondre aux styles du modèle attaché chaque fois que le document est ouvert.

areStylesUpdatedOnOpen: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si Microsoft Word incorpore des polices TrueType dans le document lors de son enregistrement.

areTrueTypeFontsEmbedded: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie un Template objet qui représente le modèle attaché au document.

attachedTemplate: Word.Template;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si la coupure d’union automatique est activée pour le document.

autoHyphenation: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si les modifications du document sont automatiquement enregistrées.

autoSaveOn: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Obtient un Shape objet qui représente l’image d’arrière-plan du document.

readonly background: Word.Shape;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un Bibliography objet qui représente les références de bibliographie contenues dans le document.

readonly bibliography: Word.Bibliography;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Obtient l’objet Body du document principal. Le corps est le texte qui exclut les en-têtes, les pieds de page, les notes de bas de page, les zones de texte, etc.

readonly body: Word.Body;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Renvoie un BookmarkCollection objet qui représente tous les signets du document.

readonly bookmarks: Word.BookmarkCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient un DocumentProperties objet qui représente toutes les propriétés de document intégrées pour le document.

readonly builtInDocumentProperties: Word.DocumentProperties;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le mode ChangeTracking.

changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-change-tracking.yaml

// Gets the current change tracking mode.
await Word.run(async (context) => {
  const document: Word.Document = context.document;
  document.load("changeTrackingMode");
  await context.sync();

  if (document.changeTrackingMode === Word.ChangeTrackingMode.trackMineOnly) {
    console.log("Only my changes are being tracked.");
  } else if (document.changeTrackingMode === Word.ChangeTrackingMode.trackAll) {
    console.log("Everyone's changes are being tracked.");
  } else {
    console.log("No changes are being tracked.");
  }
});

Obtient l’objet RangeScopedCollection qui représente tous les caractères du document.

readonly characters: Word.RangeScopedCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient un Coauthoring objet pour la gestion de la co-création dans le document.

readonly coauthoring: Word.Coauthoring;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient le nom de code du document.

readonly codeName: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient un CommentCollection objet qui représente tous les commentaires dans le document.

readonly comments: Word.CommentCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient le mode de compatibilité que Word utilise lors de l’ouverture du document.

readonly compatibilityMode: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le nombre maximal de lignes consécutives qui peuvent se terminer par des traits d’union.

consecutiveHyphensLimit: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Obtient un Range objet qui représente l’article principal du document.

readonly content: Word.Range;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient la collection d’objets ContentControl dans le document. Cela inclut les contrôles de contenu dans le corps du document, les en-têtes, les pieds de page, les zones de texte, etc.

readonly contentControls: Word.ContentControlCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient un nombre aléatoire que Word attribue aux modifications dans le document.

readonly currentRsid: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient une DocumentProperties collection qui représente toutes les propriétés personnalisées du document.

readonly customDocumentProperties: Word.DocumentProperties;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient les parties XML personnalisées dans le document.

readonly customXmlParts: Word.CustomXmlPartCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Spécifie l’intervalle (en points) entre les taquets de tabulation par défaut dans le document.

defaultTabStop: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le cadre de navigateur pour l’affichage d’une page web via un lien hypertexte.

defaultTargetFrame: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un DocumentLibraryVersionCollection objet qui représente la collection de versions d’un document partagé pour lequel le contrôle de version est activé et stocké dans une bibliothèque de documents sur un serveur.

readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si Word ne doivent pas incorporer les polices système courantes.

doNotEmbedSystemFonts: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le nom du fournisseur de chiffrement d’algorithme que Microsoft Word utilise lors du chiffrement de documents.

encryptionProvider: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie la langue d’Asie de l’Est utilisée pour le saut de ligne.

farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le niveau de contrôle de saut de ligne.

farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient un FieldCollection objet qui représente tous les champs du document.

readonly fields: Word.FieldCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si Word affiche le niveau de titre suivant lorsque le précédent est utilisé.

formattingIsNextLevelShown: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie s’il faut afficher les styles définis par l’utilisateur.

formattingIsUserStyleNameShown: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un FrameCollection objet qui représente tous les cadres du document.

readonly frames: Word.FrameCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Obtient le nom d’un document, y compris le chemin d’accès.

readonly fullName: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient un RangeCollection objet qui représente les phrases qui ont échoué à la grammaire case activée dans le document.

readonly grammaticalErrors: Word.RangeCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie l’espace horizontal entre les quadrillages invisibles que Microsoft Word utilise lorsque vous dessinez, déplacez et redimensionnez des formes automatiques ou des caractères d’Asie de l’Est dans le document.

gridDistanceHorizontal: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie l’espace vertical entre les quadrillages invisibles que Microsoft Word utilise lorsque vous dessinez, déplacez et redimensionnez des formes automatiques ou des caractères d’Asie de l’Est dans le document.

gridDistanceVertical: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si la grille de caractères commence par le coin supérieur gauche de la page.

gridIsOriginFromMargin: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le point d’origine horizontal de la grille invisible.

gridOriginHorizontal: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le point d’origine vertical de la grille invisible.

gridOriginVertical: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie l’intervalle pour le quadrillage horizontal des caractères en mode Page.

gridSpaceBetweenHorizontalLines: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie l’intervalle pour le quadrillage vertical des caractères en mode Page.

gridSpaceBetweenVerticalLines: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient si un mot de passe est requis pour ouvrir le document.

readonly hasPassword: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient si le document a un projet Microsoft Visual Basic pour Applications attaché.

readonly hasVbProject: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un HyperlinkCollection objet qui représente tous les liens hypertexte dans le document.

readonly hyperlinks: Word.HyperlinkCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si les mots de toutes les lettres majuscules peuvent être traits d’union.

hyphenateCaps: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la largeur de la zone de coupure, en points.

hyphenationZone: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un IndexCollection objet qui représente tous les index du document.

readonly indexes: Word.IndexCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les options de mise en forme automatique remplacent les restrictions de mise en forme.

isAutoFormatOverrideOn: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les graphiques du document actif utilisent le suivi des points de données de référence de cellule.

isChartDataPointTracked: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si l’option de compatibilité spécifiée par la type propriété est activée.

isCompatible: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si le document est final.

isFinal: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si Microsoft Word enregistre un sous-ensemble des polices TrueType incorporées dans le document.

isFontsSubsetSaved: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si Microsoft Word imprime sur un formulaire préimprimé uniquement les données entrées dans le formulaire en ligne correspondant.

isFormsDataPrinted: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si Microsoft Word enregistre les données entrées dans un formulaire en tant qu’enregistrement délimité par des tabulations pour une utilisation dans une base de données.

isFormsDataSaved: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si une grammaire case activée a été exécutée sur le document.

isGrammarChecked: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient si le déclenchement le plus récent de l’événement Application.DocumentBeforeSave est le résultat d’un enregistrement automatique par le document ou d’un enregistrement manuel par l’utilisateur.

readonly isInAutoSave: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient si le document est en mode création de formulaire.

readonly isInFormsDesign: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si Word caractères latins à demi-largeur et signes de ponctuation.

isKerningByAlgorithm: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie s’il faut incorporer des données vocales et d’écriture manuscrite.

isLinguisticDataEmbedded: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient si ce document est un document master.

readonly isMasterDocument: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si Word optimise le document pour Word 97.

isOptimizedForWord97: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les instructions de champ PRINT (telles que les commandes PostScript) du document doivent être imprimées par-dessus du texte et des graphiques lorsqu’une imprimante PostScript est utilisée.

isPostScriptPrintedOverText: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les utilisateurs peuvent modifier le jeu de styles rapides.

isQuickStyleSetLocked: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient si les modifications apportées au document ne peuvent pas être enregistrées dans le document d’origine.

readonly isReadOnly: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si Microsoft Word affiche une boîte de message chaque fois qu’un utilisateur ouvre le document, suggérant qu’il soit ouvert en lecture seule.

isReadOnlyRecommended: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les formes automatiques ou les caractères d’Asie de l’Est sont automatiquement alignés sur une grille invisible.

isSnappedToGrid: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les formes automatiques ou les caractères d’Asie de l’Est s’alignent sur le quadrillage invisible via d’autres formes.

isSnappedToShapes: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si l’orthographe a été vérifiée dans tout le document.

isSpellingChecked: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les restrictions de mise en forme sont appliquées dans un document protégé.

isStyleEnforced: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient si ce document est un sous-document d’un document master.

readonly isSubdocument: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les utilisateurs peuvent modifier le thème du document.

isThemeLocked: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si le document a été créé ou ouvert par l’utilisateur.

isUserControl: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient si le projet VBA est signé numériquement.

readonly isVbaSigned: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient si le document est protégé par un mot de passe en écriture.

readonly isWriteReserved: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie l’ajustement de l’espacement des caractères.

justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le type de format utilisé par Microsoft Word lors de la mise en forme automatique du document.

kind: Word.DocumentKind | "NotSpecified" | "Letter" | "Email";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si Microsoft Word a détecté la langue du texte du document.

languageDetected: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Obtient un ParagraphCollection objet qui représente tous les paragraphes numérotés dans le document.

readonly listParagraphs: Word.ParagraphCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient un ListCollection objet qui contient toutes les listes mises en forme dans le document.

readonly lists: Word.ListCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un ListTemplateCollection objet qui représente tous les modèles de liste dans le document.

readonly listTemplates: Word.ListTemplateCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie les caractères kinsoku après lesquels Word ne casseront pas de ligne.

noLineBreakAfter: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie les caractères kinsoku devant lesquels Word ne casseront pas de ligne.

noLineBreakBefore: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient l’encodage utilisé pour ouvrir le document.

readonly openEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient le titre du document d’origine après comparaison legal-blackline.

readonly originalDocumentTitle: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Retourne un PageSetup objet associé au document.

readonly pageSetup: Word.PageSetup;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Obtient un ParagraphCollection objet qui représente tous les paragraphes du document.

readonly paragraphs: Word.ParagraphCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit un mot de passe qui doit être fourni pour ouvrir le document.

password: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient l’algorithme utilisé pour le chiffrement de mot de passe.

readonly passwordEncryptionAlgorithm: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient la longueur de clé utilisée pour le chiffrement de mot de passe.

readonly passwordEncryptionKeyLength: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient le nom du fournisseur de chiffrement de mot de passe.

readonly passwordEncryptionProvider: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient le disque ou le chemin d’accès web au document (exclut le nom du document).

readonly path: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les marques de révision sont imprimées avec le document.

printRevisions: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient les propriétés du document.

readonly properties: Word.DocumentProperties;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml

await Word.run(async (context) => {
    const builtInProperties: Word.DocumentProperties = context.document.properties;
    builtInProperties.load("*"); // Let's get all!

    await context.sync();
    console.log(JSON.stringify(builtInProperties, null, 4));
});

Obtient le type de protection du document.

readonly protectionType: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient un ReadabilityStatisticCollection objet qui représente les statistiques de lisibilité pour le document.

readonly readabilityStatistics: Word.ReadabilityStatisticCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie la largeur des pages en mode Lecture en mode Mise en page lorsqu’elles sont figées.

readingLayoutSizeX: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie la hauteur des pages en mode Lecture en mode Mise en page lorsqu’elles sont figées.

readingLayoutSizeY: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les pages en mode Lecture en mode Mise en page sont figées pour le balisage manuscrit.

readingModeIsLayoutFrozen: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si Word supprime les informations utilisateur lors de l’enregistrement.

removePersonalInformationOnSave: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient le titre du document révisé après la comparaison de lignes noires juridiques.

readonly revisedDocumentTitle: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient la collection de révisions qui représente les modifications suivies dans le document.

readonly revisions: Word.RevisionCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Indique si les modifications apportées au document ont été enregistrées. La valeur indique true que le document n’a pas changé depuis son enregistrement.

readonly saved: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Spécifie l’encodage utilisé lors de l’enregistrement du document.

saveEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient le format de fichier du document.

readonly saveFormat: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient la collection d’objets Section dans le document.

readonly sections: Word.SectionCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Renvoie un Selection objet qui représente la sélection actuelle dans le document.

readonly selection: Word.Selection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient l’objet RangeScopedCollection qui représente toutes les phrases du document.

readonly sentences: Word.RangeScopedCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient les paramètres du complément dans le document.

readonly settings: Word.SettingCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml

// Gets all custom settings this add-in set on this document.
await Word.run(async (context) => {
  const settings: Word.SettingCollection = context.document.settings;
  settings.load("items");
  await context.sync();

  if (settings.items.length == 0) {
    console.log("There are no settings.");
  } else {
    console.log("All settings:");
    for (let i = 0; i < settings.items.length; i++) {
      console.log(settings.items[i]);
    }
  }
});

Obtient un RangeCollection objet qui représente les mots identifiés comme des fautes d’orthographe dans le document.

readonly spellingErrors: Word.RangeCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient un RangeCollection objet qui représente tous les articles du document.

readonly storyRanges: Word.RangeCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient un StyleCollection pour le document.

readonly styles: Word.StyleCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un TableOfAuthoritiesCategoryCollection objet qui représente la table des catégories de références disponibles dans le document.

readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient un TableCollection objet qui représente toutes les tables du document.

readonly tables: Word.TableCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un TableOfAuthoritiesCollection objet qui représente toutes les tables de références dans le document.

readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un TableOfContentsCollection objet qui représente toutes les tables des matières du document.

readonly tablesOfContents: Word.TableOfContentsCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un TableOfFiguresCollection objet qui représente toutes les tables de figures du document.

readonly tablesOfFigures: Word.TableOfFiguresCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie l’encodage pour l’enregistrement en tant que texte codé.

textEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie comment Word marque les sauts de ligne et de paragraphe dans les fichiers texte.

textLineEnding: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie s’il faut supprimer ou stocker les métadonnées de date et d’heure pour le suivi des modifications.

trackedChangesAreDateAndTimeRemoved: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie s’il faut suivre les modifications de mise en forme lorsque le suivi des modifications est activé.

trackFormatting: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie s’il faut marquer le texte déplacé lorsque le suivi des modifications est activé.

trackMoves: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les modifications sont suivies dans le document.

trackRevisions: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient le type de document (modèle ou document).

readonly type: Word.DocumentType | "Document" | "Template" | "Frameset";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient l’objet WebSettings pour les attributs liés à la page web.

readonly webSettings: Word.WebSettings;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient la collection d’objets Word.Window pour le document.

readonly windows: Word.WindowCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the document windows.
  const windows: Word.WindowCollection = context.document.windows;
  windows.load("windows/items/length");

  await context.sync();

  console.log(`Number of windows for this document: ${windows.items.length}`);
});

Obtient l’objet RangeScopedCollection qui représente chaque mot du document.

readonly words: Word.RangeScopedCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit un mot de passe pour enregistrer les modifications apportées au document.

writePassword: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si les messages d’erreur sont générés à partir de messages Word intégrés ou de MSXML (Microsoft XML).

xmlAreAdvancedErrorsShown: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie s’il faut enregistrer un document par le biais d’une transformation XSLT (Extensible Stylesheet Language Transformation).

xmlIsXsltUsedWhenSaving: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le chemin d’accès et le nom de fichier du XSLT à appliquer lors de l’enregistrement d’un document.

xmlSaveThroughXslt: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Accepte toutes les modifications suivies dans le document.

acceptAllRevisions(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Accepte toutes les révisions du document affichées à l’écran.

acceptAllRevisionsShown(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Active le document afin qu’il devienne le document actif.

activate(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Ajoute un style dans le document par nom et par type.

addStyle(name: string, type: Word.StyleType): Word.Style;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Adds a new style.
await Word.run(async (context) => {
  const newStyleName = (document.getElementById("new-style-name") as HTMLInputElement).value;
  if (newStyleName == "") {
    console.warn("Enter a style name to add.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(newStyleName);
  style.load();
  await context.sync();

  if (!style.isNullObject) {
    console.warn(
      `There's an existing style with the same name '${newStyleName}'! Please provide another style name.`
    );
    return;
  }

  const newStyleType = ((document.getElementById("new-style-type") as HTMLSelectElement).value as unknown) as Word.StyleType;
  context.document.addStyle(newStyleName, newStyleType);
  await context.sync();

  console.log(newStyleName + " has been added to the style list.");
});

Ajoute un style dans le document par nom et par type.

addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Crée un raccourci vers le document ou le lien hypertexte et l’ajoute au dossier Favoris .

addToFavorites(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Applique le jeu de styles rapides spécifié au document.

applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Applique le jeu de styles rapides spécifié au document.

applyQuickStyleSet(style: "SessionStart" | "Template"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Applique le thème spécifié à ce document.

applyTheme(name: string): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Met automatiquement en forme le document.

autoFormat(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Retourne true si Microsoft Word peut case activée dans le document sur un serveur.

canCheckin(): OfficeExtension.ClientResult<boolean>;

Retours

true si le document peut être archivé ; sinon, false.

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Examine le texte d'un document japonais et affiche les occurrences où l'utilisation des caractères utilisés dans les mêmes termes n'est pas cohérente.

checkConsistencyJapanese(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Commence une case activée orthographique et grammaticale pour le document.

checkGrammar(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Archive le document de l’ordinateur local vers un serveur et définit le document local en lecture seule afin qu’il ne puisse pas être modifié localement.

checkIn(options?: Word.DocumentCheckInOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Enregistre le document sur un serveur à partir d’un ordinateur local et définit le document local en lecture seule afin qu’il ne puisse pas être modifié localement.

checkInWithVersion(options?: Word.DocumentCheckInWithVersionOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Commence une case activée orthographique pour le document.

checkSpelling(options?: Word.DocumentCheckSpellingOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Ferme le document actif.

Remarque : cette API n’est pas prise en charge dans Word sur le web.

close(closeBehavior?: Word.CloseBehavior): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml

// Closes the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
  context.document.close();
});

Ferme le document actif.

Remarque : cette API n’est pas prise en charge dans Word sur le web.

close(closeBehavior?: "Save" | "SkipSave"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Bascule le document de l’aperçu avant impression vers l’affichage précédent.

closePrintPreview(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Affiche des marques de révision qui indiquent en quoi le document spécifié diffère d'un autre document.

compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/compare-documents.yaml

// Compares the current document with a specified external document.
await Word.run(async (context) => {
  // Absolute path of an online or local document.
  const filePath = (document.getElementById("filePath") as HTMLInputElement).value;
  // Options that configure the compare operation.
  const options: Word.DocumentCompareOptions = {
    compareTarget: Word.CompareTarget.compareTargetCurrent,
    detectFormatChanges: false
    // Other options you choose...
    };
  context.document.compare(filePath, options);

  await context.sync();

  console.log("Differences shown in the current document.");
});

Affiche des marques de révision qui indiquent en quoi le document spécifié diffère d'un autre document.

compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Retourne une statistique basée sur le contenu du document.

computeStatistics(statistic: Word.StatisticType, includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult<number>;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Retourne une statistique basée sur le contenu du document.

computeStatistics(statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters", includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult<number>;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Convertit le fichier au format le plus récent et active toutes les fonctionnalités.

convert(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Convertit les traits d’union automatiques en traits d’union manuels.

convertAutoHyphens(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Remplace les numéros de liste et les champs LISTNUM du document en texte.

convertNumbersToText(numberType?: Word.NumberType): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Remplace les numéros de liste et les champs LISTNUM du document en texte.

convertNumbersToText(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Reconvertit un document vietnamien en format Unicode à l'aide d'une page de codes différente de la page de codes par défaut.

convertVietnameseDocument(codePageOrigin: number): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Copie les styles du modèle spécifié vers le document.

copyStylesFromTemplate(StyleTemplate: string): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie le nombre d’éléments à puces ou numérotés et de champs LISTNUM dans le document.

countNumberedItems(options?: Word.DocumentCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;

Paramètres

Retours

Nombre d’éléments numérotés.

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Supprime tous les commentaires du document.

deleteAllComments(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime toutes les révisions du document qui s’affichent à l’écran.

deleteAllCommentsShown(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime toutes les annotations manuscrites dans le document.

deleteAllInkAnnotations(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime un signet, s’il existe, du document.

deleteBookmark(name: string): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Analyse le texte du document pour déterminer la langue.

detectLanguage(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Met fin à une révision du fichier qui a été envoyé pour révision.

endReview(options?: Word.DocumentEndReviewOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Enregistre le document au format PDF ou XPS.

exportAsFixedFormat(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormatOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Enregistre le document au format PDF ou XPS.

exportAsFixedFormat(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormatOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Enregistre le document au format PDF ou XPS.

exportAsFixedFormat2(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat2Options): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Enregistre le document au format PDF ou XPS.

exportAsFixedFormat2(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat2Options): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Enregistre le document au format PDF ou XPS avec un balisage amélioré.

exportAsFixedFormat3(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat3Options): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Enregistre le document au format PDF ou XPS avec un balisage amélioré.

exportAsFixedFormat3(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat3Options): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Réduit la taille de police du texte juste assez pour que le nombre de pages de document diminue d’un.

fitToPages(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Cette méthode affiche un document mis en mémoire cache, s'il a déjà été téléchargé. Sinon, elle recherche le lien hypertexte, télécharge le document cible, puis affiche le document dans l'application appropriée.

followHyperlink(options?: Word.DocumentFollowHyperlinkOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Corrige la disposition du document en mode Web.

freezeLayout(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient l’annotation par ID. Génère une ItemNotFound erreur si l’annotation est introuvable.

getAnnotationById(id: string): Word.Annotation;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.7 ]

Obtient la plage d’un signet. Génère une ItemNotFound erreur si le signet n’existe pas.

getBookmarkRange(name: string): Word.Range;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Obtient la plage d’un signet. Si le signet n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getBookmarkRangeOrNullObject(name: string): Word.Range;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Obtient les contrôles de contenu actuellement pris en charge dans le document.

getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Important : si des types spécifiques sont fournis dans le paramètre options, seuls les contrôles de contenu des types pris en charge sont retournés. N’oubliez pas qu’une exception sera levée à l’aide de méthodes d’un Word générique. ContentControl qui ne sont pas pertinents pour le type spécifique. Avec le temps, d’autres types de contrôles de contenu peuvent être pris en charge. Par conséquent, votre complément doit demander et gérer des types spécifiques de contrôles de contenu.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-checkbox-content-control.yaml

// Toggles the isChecked property on all checkbox content controls.
await Word.run(async (context) => {
  let contentControls = context.document.getContentControls({
    types: [Word.ContentControlType.checkBox]
  });
  contentControls.load("items");

  await context.sync();

  const length = contentControls.items.length;
  console.log(`Number of checkbox content controls: ${length}`);

  if (length <= 0) {
    return;
  }

  const checkboxContentControls = [];
  for (let i = 0; i < length; i++) {
    let contentControl = contentControls.items[i];
    contentControl.load("id,checkboxContentControl/isChecked");
    checkboxContentControls.push(contentControl);
  }

  await context.sync();

  console.log("isChecked state before:");
  const updatedCheckboxContentControls = [];
  for (let i = 0; i < checkboxContentControls.length; i++) {
    const currentCheckboxContentControl = checkboxContentControls[i];
    const isCheckedBefore = currentCheckboxContentControl.checkboxContentControl.isChecked;
    console.log(`id: ${currentCheckboxContentControl.id} ... isChecked: ${isCheckedBefore}`);

    currentCheckboxContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
    currentCheckboxContentControl.load("id,checkboxContentControl/isChecked");
    updatedCheckboxContentControls.push(currentCheckboxContentControl);
  }

  await context.sync();

  console.log("isChecked state after:");
  for (let i = 0; i < updatedCheckboxContentControls.length; i++) {
    const currentCheckboxContentControl = updatedCheckboxContentControls[i];
    console.log(
      `id: ${currentCheckboxContentControl.id} ... isChecked: ${currentCheckboxContentControl.checkboxContentControl.isChecked}`
    );
  }
});

Cette méthode renvoie un tableau d'éléments pouvant être renvoyés en fonction du type de renvoi spécifié.

getCrossReferenceItems(referenceType: Word.ReferenceType): OfficeExtension.ClientResult<string[]>;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Cette méthode renvoie un tableau d'éléments pouvant être renvoyés en fonction du type de renvoi spécifié.

getCrossReferenceItems(referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"): OfficeExtension.ClientResult<string[]>;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient les notes de fin du document dans un corps unique.

getEndnoteBody(): Word.Body;

Retours

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Obtient les notes de bas de page du document dans un seul corps.

getFootnoteBody(): Word.Body;

Retours

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Obtient le paragraphe par son ID local unique. Génère une ItemNotFound erreur si la collection est vide.

getParagraphByUniqueLocalId(id: string): Word.Paragraph;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml

await Word.run(async (context) => {
  const paragraphId = (document.getElementById("paragraph-id") as HTMLInputElement).value;
  const paragraph: Word.Paragraph = context.document.getParagraphByUniqueLocalId(paragraphId);
  paragraph.load();
  await paragraph.context.sync();

  console.log(paragraph);
});

Retourne un Range objet en utilisant les positions de caractère de début et de fin spécifiées.

getRange(options?: Word.DocumentRangeOptions): Word.Range;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Obtient la sélection actuelle du document. Les sélections multiples ne sont pas prises en charge.

getSelection(): Word.Range;

Retours

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    const textSample = 'This is an example of the insert text method. This is a method ' + 
        'which allows users to insert text into a selection. It can insert text into a ' +
        'relative location or it can overwrite the current selection. Since the ' +
        'getSelection method returns a range object, look up the range object documentation ' +
        'for everything you can do with a selection.';
    
    // Create a range proxy object for the current selection.
    const range = context.document.getSelection();
    
    // Queue a command to insert text at the end of the selection.
    range.insertText(textSample, Word.InsertLocation.end);
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted the text at the end of the selection.');
});  

Obtient un StyleCollection objet qui représente l’ensemble du jeu de styles du document.

getStyles(): Word.StyleCollection;

Retours

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Gets the number of available styles stored with the document.
await Word.run(async (context) => {
  const styles: Word.StyleCollection = context.document.getStyles();
  const count = styles.getCount();
  await context.sync();

  console.log(`Number of styles: ${count.value}`);
});

Renvoie un Range objet qui représente la position de début de l’élément spécifié, tel qu’une page, un signet ou un champ.

goTo(options?: Word.GoToOptions): Word.Range;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Importer des styles à partir d’une chaîne au format JSON.

importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Remarque : Le importedStylesConflictBehavior paramètre a été introduit dans WordApiDesktop 1.1.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-custom-style.yaml

// Imports styles from JSON.
await Word.run(async (context) => {
  const str =
    '{"styles":[{"baseStyle":"Default Paragraph Font","builtIn":false,"inUse":true,"linked":false,"nameLocal":"NewCharStyle","priority":2,"quickStyle":true,"type":"Character","unhideWhenUsed":false,"visibility":false,"paragraphFormat":null,"font":{"name":"DengXian Light","size":16.0,"bold":true,"italic":false,"color":"#F1A983","underline":"None","subscript":false,"superscript":true,"strikeThrough":true,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#FF0000"}},{"baseStyle":"Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewParaStyle","nameLocal":"NewParaStyle","priority":1,"quickStyle":true,"type":"Paragraph","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Centered","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":72.0,"lineSpacing":18.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":72.0,"spaceAfter":30.0,"spaceBefore":30.0,"widowControl":true},"font":{"name":"DengXian","size":14.0,"bold":true,"italic":true,"color":"#8DD873","underline":"Single","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":true,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#00FF00"}},{"baseStyle":"Table Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewTableStyle","nameLocal":"NewTableStyle","priority":100,"type":"Table","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Left","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":0.0,"lineSpacing":12.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":0.0,"spaceAfter":0.0,"spaceBefore":0.0,"widowControl":true},"font":{"name":"DengXian","size":20.0,"bold":false,"italic":true,"color":"#D86DCB","underline":"None","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"tableStyle":{"allowBreakAcrossPage":true,"alignment":"Left","bottomCellMargin":0.0,"leftCellMargin":0.08,"rightCellMargin":0.08,"topCellMargin":0.0,"cellSpacing":0.0},"shading":{"backgroundPatternColor":"#60CAF3"}}]}';
  const styles = context.document.importStylesFromJson(str);

  // If you'd like to set how conflicting styles are handled, use the importedStylesConflictBehavior parameter that was introduced in the Desktop 1.1 requirement set. "Ignore" is the default.
  ////const styles = context.document.importStylesFromJson(str, Word.ImportedStylesConflictBehavior.Ignore);

  await context.sync();
  console.log("Styles imported from JSON:", styles);
});

Importer des styles à partir d’une chaîne au format JSON.

importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult<string[]>;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Remarque : Le importedStylesConflictBehavior paramètre a été introduit dans WordApiDesktop 1.1.

Insère un document dans le document cible à un emplacement spécifique avec des propriétés supplémentaires. Les en-têtes, pieds de page, filigranes et autres propriétés de section sont copiés par défaut.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.5 ]

L’insertion n’est pas prise en charge si le document inséré contient un contrôle ActiveX (probablement dans un champ de formulaire). Envisagez de remplacer un tel champ de formulaire par un contrôle de contenu ou une autre option appropriée pour votre scénario.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml

// Inserts content (applying selected settings) from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  // Use the Base64-encoded string representation of the selected .docx file.
  context.document.insertFileFromBase64(externalDocument, "Replace", {
    importTheme: true,
    importStyles: true,
    importParagraphSpacing: true,
    importPageColor: true,
    importChangeTrackingMode: true,
    importCustomProperties: true,
    importCustomXmlParts: true,
    importDifferentOddEvenPages: true
  });
  await context.sync();
});

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document;

Paramètres

Retours

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the document.
    const thisDocument = context.document;
    
    // Queue a command to load content control properties.
    thisDocument.load('contentControls/id, contentControls/text, contentControls/tag');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (thisDocument.contentControls.items.length !== 0) {
        for (let i = 0; i < thisDocument.contentControls.items.length; i++) {
            console.log(thisDocument.contentControls.items[i].id);
            console.log(thisDocument.contentControls.items[i].text);
            console.log(thisDocument.contentControls.items[i].tag);
        }
    } else {
        console.log('No content controls in this document.');
    }
});

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Word.Document;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Document;

Paramètres

Retours

Verrouille le fichier sur le serveur pour empêcher sa modification.

lockServerFile(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit les options de compatibilité.

makeCompatibilityDefault(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Démarre la coupure de mots manuelle dans un document, dans un processus ligne par ligne.

manualHyphenation(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Fusionne d'un document dans un autre les changements signalés par des marques de révision.

merge(fileName: string, options?: Word.DocumentMergeOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Publie le document dans un dossier public dans Microsoft Exchange.

post(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Ouvre PowerPoint avec le document Word chargé.

presentIt(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Imprime tout ou partie du document.

printOut(options?: Word.DocumentPrintOutOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Active le mode Aperçu avant impression.

printPreview(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Protège le document contre les modifications non autorisées.

protect(type: Word.ProtectionType, options?: Word.DocumentProtectOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Protège le document contre les modifications non autorisées.

protect(type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading", options?: Word.DocumentProtectOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Rétablit la dernière action qui a été annulée (inverse la undo méthode).

redo(times?: number): OfficeExtension.ClientResult<boolean>;

Paramètres

Retours

true si les actions ont été refaites avec succès ; sinon, false.

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Rejette toutes les modifications suivies dans le document.

rejectAllRevisions(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Rejette toutes les révisions du document affichées à l’écran.

rejectAllRevisionsShown(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Cette méthode recharge un document mis en mémoire cache en recherchant le lien hypertexte relatif au document et en le téléchargeant.

reload(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Recharge le document en fonction d’un document HTML, à l’aide de l’encodage du document.

reloadAs(encoding: Word.DocumentEncoding): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Recharge le document en fonction d’un document HTML, à l’aide de l’encodage du document.

reloadAs(encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime des informations sensibles, des propriétés, des commentaires et d’autres métadonnées du document.

removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime des informations sensibles, des propriétés, des commentaires et d’autres métadonnées du document.

removeDocumentInformation(removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Vide le document des styles verrouillés lorsque des restrictions de mise en forme ont été appliquées dans le document.

removeLockedStyles(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime des numéros ou des puces du document.

removeNumbers(numberType?: Word.NumberType): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime des numéros ou des puces du document.

removeNumbers(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime le thème actif du document actif.

removeTheme(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Repagine l'ensemble du document.

repaginate(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Envoie un e-mail à l’auteur du document qui a été envoyé pour révision, l’informant qu’un réviseur a terminé la révision du document.

replyWithChanges(options?: Word.DocumentReplyWithChangesOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Efface tous les champs de formulaire dans le document, en préparant le formulaire à remplir à nouveau.

resetFormFields(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Retourne le document à la dernière position de lecture enregistrée.

returnToLastReadPosition(): OfficeExtension.ClientResult<number>;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Exécute une macro automatique stockée dans le document. Si la macro automatique spécifiée n'existe pas, aucune action n'est exécutée.

runAutoMacro(autoMacro: Word.AutoMacro): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Exécute une macro automatique stockée dans le document. Si la macro automatique spécifiée n'existe pas, aucune action n'est exécutée.

runAutoMacro(autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Enregistre le document.

save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Remarque : Les saveBehavior paramètres et fileName ont été introduits dans WordApi 1.5.

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the document.
    const thisDocument = context.document;

    // Queue a command to load the document save state (on the saved property).
    thisDocument.load('saved');    
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (thisDocument.saved === false) {
        // Queue a command to save this document.
        thisDocument.save();
        
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Saved the document');
    } else {
        console.log('The document has not changed since the last save.');
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml

// Saves the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
  context.document.save();
  await context.sync();
});

Enregistre le document.

save(saveBehavior?: "Save" | "Prompt", fileName?: string): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Remarque : Les saveBehavior paramètres et fileName ont été introduits dans WordApi 1.5.

Enregistre le groupe de styles rapides en cours d'utilisation.

saveAsQuickStyleSet(fileName: string): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Effectue une recherche avec les options de recherche spécifiées sur l’étendue de l’ensemble du document. Les résultats de la recherche sont une collection d’objets Range .

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.7 ]

Sélectionne le contenu du document.

select(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Retourne tous les contrôles de contenu avec la balise spécifiée.

selectContentControlsByTag(tag: string): Word.ContentControlCollection;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un ContentControlCollection objet qui représente tous les contrôles de contenu dans le document avec le titre spécifié.

selectContentControlsByTitle(title: string): Word.ContentControlCollection;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un ContentControlCollection objet qui représente tous les contrôles de contenu dans le document qui sont liés au nœud XML personnalisé spécifique.

selectLinkedControls(node: Word.CustomXmlNode): Word.ContentControlCollection;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un XmlNodeCollection objet qui représente tous les nœuds qui correspondent au paramètre XPath dans l’ordre dans lequel ils apparaissent dans le document.

selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un XmlNode objet qui représente le premier nœud qui correspond au paramètre XPath dans le document.

selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Renvoie un ContentControlCollection objet qui représente tous les contrôles de contenu du document qui ne sont pas liés à un nœud XML.

selectUnlinkedControls(stream?: Word.CustomXmlPart): Word.ContentControlCollection;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Envoie le document sous forme de télécopie, sans aucune interaction de l’utilisateur.

sendFax(address: string, subject?: string): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Envoie le document à un fournisseur de services de télécopie, qui le faxe à un ou plusieurs destinataires spécifiés.

sendFaxOverInternet(options?: Word.DocumentSendFaxOverInternetOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Envoie le document dans un e-mail pour révision par les destinataires spécifiés.

sendForReview(options?: Word.DocumentSendForReviewOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

Ouvre une fenêtre de message pour l’envoi du document via Microsoft Exchange.

sendMail(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.Document): void;

Paramètres

Retours

Spécifie le style de tableau à utiliser pour les tableaux nouvellement créés dans le document.

setDefaultTableStyle(style: string, setInTemplate: boolean): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit les options que Microsoft Word utilise pour chiffrer les documents protégés par mot de passe.

setPasswordEncryptionOptions(passwordEncryptionProvider: string, passwordEncryptionAlgorithm: string, passwordEncryptionKeyLength: number, passwordEncryptFileProperties?: boolean): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Active ou désactive le mode Création de formulaire.

toggleFormsDesign(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.Document est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.DocumentDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.DocumentData;

Retours

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.Document;

Retours

Applique le fichier XSLT (Extensible Stylesheet Language Transformation) spécifié à ce document et remplace le document par les résultats.

transformDocument(path: string, dataOnly?: boolean): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Annule la dernière action ou une séquence d'actions affichées dans la liste Annuler.

undo(times?: number): OfficeExtension.ClientResult<boolean>;

Paramètres

Retours

true si les actions ont été annulées avec succès ; sinon, false.

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Efface la liste des actions qui peuvent être annulées dans le document.

undoClear(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Supprime la protection du document.

unprotect(password?: string): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): Word.Document;

Retours

Copie dans le document tous les styles du modèle attaché, en écrasant tout style précédent qui porte le même nom.

updateStyles(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Affiche la fenêtre de code du contrôle Microsoft ActiveX sélectionné dans le document.

viewCode(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Affiche la fenêtre de propriétés du contrôle Microsoft ActiveX sélectionné dans le document.

viewPropertyBrowser(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Affiche un aperçu du document actif tel qu’il serait enregistré en tant que page web.

webPagePreview(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Se produit lorsque l’utilisateur clique sur une annotation (ou la sélectionne à l’aide de Alt+Bas).

readonly onAnnotationClicked: OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>;

Type d'événement

Remarques

[ Ensemble d’API : WordApi 1.7 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onClickedHandler(args: Word.AnnotationClickedEventArgs) {
  await Word.run(async (context) => {
    const annotation: Word.Annotation = context.document.getAnnotationById(args.id);
    annotation.load("critiqueAnnotation");

    await context.sync();

    console.log(`AnnotationClicked: ID ${args.id}:`, annotation.critiqueAnnotation.critique);
  });
}

Se produit lorsque l’utilisateur place le curseur sur une annotation.

readonly onAnnotationHovered: OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>;

Type d'événement

Remarques

[ Ensemble d’API : WordApi 1.7 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onHoveredHandler(args: Word.AnnotationHoveredEventArgs) {
  await Word.run(async (context) => {
    const annotation: Word.Annotation = context.document.getAnnotationById(args.id);
    annotation.load("critiqueAnnotation");

    await context.sync();

    console.log(`AnnotationHovered: ID ${args.id}:`, annotation.critiqueAnnotation.critique);
  });
}

Se produit lorsque l’utilisateur ajoute une ou plusieurs annotations.

readonly onAnnotationInserted: OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>;

Type d'événement

Remarques

[ Ensemble d’API : WordApi 1.7 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onInsertedHandler(args: Word.AnnotationInsertedEventArgs) {
  await Word.run(async (context) => {
    const annotations = [];
    for (let i = 0; i < args.ids.length; i++) {
      let annotation: Word.Annotation = context.document.getAnnotationById(args.ids[i]);
      annotation.load("id,critiqueAnnotation");

      annotations.push(annotation);
    }

    await context.sync();

    for (let annotation of annotations) {
      console.log(`AnnotationInserted: ID ${annotation.id}:`, annotation.critiqueAnnotation.critique);
    }
  });
}

Se produit lorsque l’utilisateur effectue une action dans un menu contextuel d’annotation.

readonly onAnnotationPopupAction: OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>;

Type d'événement

Remarques

[ Ensemble d’API : WordApi 1.8 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onPopupActionHandler(args: Word.AnnotationPopupActionEventArgs) {
  await Word.run(async (context) => {
    let message = `AnnotationPopupAction: ID ${args.id} = `;
    if (args.action === "Accept") {
      message += `Accepted: ${args.critiqueSuggestion}`;
    } else {
      message += "Rejected";
    }

    console.log(message);
  });
}

Se produit lorsque l’utilisateur supprime une ou plusieurs annotations.

readonly onAnnotationRemoved: OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>;

Type d'événement

Remarques

[ Ensemble d’API : WordApi 1.7 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onRemovedHandler(args: Word.AnnotationRemovedEventArgs) {
  await Word.run(async (context) => {
    for (let id of args.ids) {
      console.log(`AnnotationRemoved: ID ${id}`);
    }
  });
}

Se produit lorsqu’un contrôle de contenu est ajouté. Exécutez context.sync() dans le gestionnaire pour obtenir les propriétés du nouveau contrôle de contenu.

readonly onContentControlAdded: OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>;

Type d'événement

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/content-control-onadded-event.yaml

// Registers the onAdded event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onContentControlAdded.add(contentControlAdded);
  await context.sync();

  console.log("Added event handler for when content controls are added.");
});

...

async function contentControlAdded(event: Word.ContentControlAddedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. IDs of content controls that were added:`, event.ids);
  });
}

Se produit lorsque l’utilisateur ajoute de nouveaux paragraphes.

readonly onParagraphAdded: OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>;

Type d'événement

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml

// Registers the onParagraphAdded event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphAdded.add(paragraphAdded);
  await context.sync();

  console.log("Added event handler for when paragraphs are added.");
});

...

async function paragraphAdded(event: Word.ParagraphAddedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs that were added:`, event.uniqueLocalIds);
  });
}

Se produit lorsque l’utilisateur modifie des paragraphes.

readonly onParagraphChanged: OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>;

Type d'événement

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onchanged-event.yaml

// Registers the onParagraphChanged event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphChanged.add(paragraphChanged);
  await context.sync();

  console.log("Added event handler for when content is changed in paragraphs.");
});

...

async function paragraphChanged(event: Word.ParagraphChangedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs where content was changed:`, event.uniqueLocalIds);
  });
}

Se produit lorsque l’utilisateur supprime des paragraphes.

readonly onParagraphDeleted: OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>;

Type d'événement

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/ondeleted-event.yaml

// Registers the onParagraphDeleted event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphDeleted.add(paragraphDeleted);
  await context.sync();

  console.log("Added event handlers for when paragraphs are deleted.");
});

...

async function paragraphDeleted(event: Word.ParagraphDeletedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs that were deleted:`, event.uniqueLocalIds);
  });
}