Word. Document class

Utilisateur

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.");
  }
});

Propriétés

activeTheme	Obtient le nom du thème actif et des options de mise en forme.
activeThemeDisplayName	Obtient le nom d’affichage du thème actif.
activeWindow	Récupère la fenêtre active du document.
areFilePropertiesPasswordEncrypted	Indique si Word chiffre les propriétés de fichier des documents protégés par mot de passe.
areGrammaticalErrorsShown	Indique si les erreurs grammaticales sont signalées par une ligne verte ondulée dans le document.
areMathDefaultsUsed	Indique s’il faut utiliser les paramètres mathématiques par défaut lors de la création de nouvelles équations.
areNewerFeaturesDisabled	Indique s’il faut désactiver les fonctionnalités introduites après une version spécifiée.
areSpellingErrorsShown	Indique si Microsoft Word souligne les fautes d’orthographe dans le document.
areStylesUpdatedOnOpen	Indique si les styles de ce document sont mis à jour pour correspondre aux styles du modèle joint chaque fois que le document est ouvert.
areTrueTypeFontsEmbedded	Indique si Microsoft Word incorpore des polices TrueType dans le document lors de son enregistrement.
attachedTemplate	Spécifie un `Template` objet représentant le modèle joint au document.
autoHyphenation	Spécifie si la césure automatique est activée pour le document.
autoSaveOn	Indique si les modifications apportées au document sont automatiquement enregistrées.
background	Obtient un `Shape` objet qui représente l’image d’arrière-plan du document.
bibliography	Renvoie un `Bibliography` objet qui représente les références bibliographiques contenues dans le document.
body	Récupère l’objet `Body` du document principal. Le corps est le texte qui exclut les en-têtes, pieds de page, notes de bas de page, zones de texte, etc.
bookmarks	Renvoie un `BookmarkCollection` objet qui représente tous les signets du document.
builtInDocumentProperties	Obtient un `DocumentProperties` objet qui représente toutes les propriétés de document intégrées pour le document.
changeTrackingMode	Spécifie le mode ChangeTracking.
characters	Obtient l’objet `RangeScopedCollection` qui représente tous les caractères du document.
coauthoring	Obtient un `Coauthoring` objet de gestion de la co-édition dans le document.
codeName	Obtient le nom de code du document.
comments	Obtient un `CommentCollection` objet qui représente tous les commentaires dans le document.
compatibilityMode	Obtient le mode de compatibilité que Word utilise lors de l’ouverture du document.
consecutiveHyphensLimit	Indique le nombre maximal de lignes consécutives qui peuvent se terminer par des traits d’union.
content	Obtient un `Range` objet qui représente l’histoire du document principal.
contentControls	Obtient la collection d’objets `ContentControl` du 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.
context	Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
currentRsid	Obtient un nombre aléatoire que Word affecte aux modifications apportées au document.
customDocumentProperties	Obtient une `DocumentProperties` collection qui représente toutes les propriétés de document personnalisé pour le document.
customXmlParts	Obtient les parties XML personnalisées du document.
defaultTabStop	Indique l’intervalle (en points) entre les taquets de tabulation par défaut dans le document.
defaultTargetFrame	Spécifie le cadre du navigateur pour afficher une page web via un lien hypertexte.
documentLibraryVersions	Renvoie un `DocumentLibraryVersionCollection` objet qui représente la collection des versions d’un document partagé dont le contrôle de version est activé et qui est stocké dans une bibliothèque de documents sur un serveur.
doNotEmbedSystemFonts	Spécifie si Word ne doit pas incorporer les polices système courantes.
encryptionProvider	Spécifie le nom du fournisseur de chiffrement d’algorithme utilisé par Microsoft Word pour chiffrer des documents.
farEastLineBreakLanguage	Spécifie la langue d’Asie de l’Est utilisée pour les sauts de ligne.
farEastLineBreakLevel	Spécifie le niveau de contrôle des sauts de ligne.
fields	Récupère un `FieldCollection` objet qui représente tous les champs du document.
formattingIsNextLevelShown	Indique si Word affiche le niveau de titre suivant lorsque le précédent est utilisé.
formattingIsUserStyleNameShown	Indique s’il faut afficher les styles définis par l’utilisateur.
frames	Renvoie un `FrameCollection` objet qui représente toutes les images du document.
fullName	Récupère le nom d’un document, dont le chemin d’accès est inclus.
grammaticalErrors	Obtient un `RangeCollection` objet qui représente les phrases qui ont échoué à la case activée grammaticale dans le document.
gridDistanceHorizontal	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 orientale dans le document.
gridDistanceVertical	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 orientale dans le document.
gridIsOriginFromMargin	Indique si la grille de caractères commence à partir du coin supérieur gauche de la page.
gridOriginHorizontal	Spécifie le point d’origine horizontal de la grille invisible.
gridOriginVertical	Spécifie le point d’origine vertical de la grille invisible.
gridSpaceBetweenHorizontalLines	Spécifie l’intervalle entre les quadrillages de caractères horizontaux en mode Page.
gridSpaceBetweenVerticalLines	Spécifie l’intervalle entre les quadrillages de caractères verticaux en mode Page.
hasPassword	Indique si un mot de passe est requis pour ouvrir le document.
hasVbProject	Indique si un projet Microsoft Visual Basic pour Applications est associé au document.
hyperlinks	Renvoie un `HyperlinkCollection` objet qui représente tous les liens hypertexte dans le document.
hyphenateCaps	Indique si les mots en lettres majuscules peuvent être coupés.
hyphenationZone	Spécifie la largeur de la zone de césure, en points.
indexes	Renvoie un `IndexCollection` objet qui représente tous les index dans le document.
isAutoFormatOverrideOn	Indique si les options de mise en forme automatique remplacent les restrictions de mise en forme.
isChartDataPointTracked	Indique si les graphiques du document actif utilisent le suivi des points de données de référence de cellule.
isCompatible	Indique si l’option de compatibilité spécifiée par la `type` propriété est activée.
isFinal	Indique si le document est définitif.
isFontsSubsetSaved	Indique si Microsoft Word enregistre un sous-ensemble des polices TrueType incorporées avec le document.
isFormsDataPrinted	Indique si Microsoft Word imprime sur un formulaire préimprimé uniquement les données entrées dans le formulaire en ligne correspondant.
isFormsDataSaved	Indique si Microsoft Word enregistre les données entrées dans un formulaire sous la forme d’un enregistrement délimité par des tabulations en vue de leur utilisation dans une base de données.
isGrammarChecked	Indique si une case activée grammaticale a été effectuée sur le document.
isInAutoSave	Indique 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.
isInFormsDesign	Détermine si le document est en mode Création de formulaire.
isKerningByAlgorithm	Indique si le crénage de Word applique les caractères latins à demi-chasse et les signes de ponctuation.
isLinguisticDataEmbedded	Indique s’il faut incorporer des données vocales et d’écriture manuscrite.
isMasterDocument	Détermine si ce document est un document master.
isOptimizedForWord97	Indique si Word optimise le document pour Word 97.
isPostScriptPrintedOverText	Spécifie si les instructions de champ PRINT (telles que les commandes PostScript) du document doivent être imprimées au-dessus du texte et des graphiques lorsqu’une imprimante PostScript est utilisée.
isQuickStyleSetLocked	Indique si les utilisateurs peuvent modifier le jeu de styles rapides.
isReadOnly	Recherche à déterminer si les modifications apportées au document ne peuvent pas être enregistrées dans le document d’origine.
isReadOnlyRecommended	Indique si Microsoft Word affiche une zone de message chaque fois qu’un utilisateur ouvre le document, suggérant de l’ouvrir en lecture seule.
isSnappedToGrid	Spécifie si les formes automatiques ou les caractères d’Asie orientale sont automatiquement alignés sur une grille invisible.
isSnappedToShapes	Indique si les formes automatiques ou les caractères d’Asie orientale s’alignent sur un quadrillage invisible à travers d’autres formes.
isSpellingChecked	Indique si l’orthographe a été vérifiée dans l’ensemble du document.
isStyleEnforced	Indique si les restrictions de mise en forme sont appliquées dans un document protégé.
isSubdocument	Détermine si ce document est un sous-document d’un document master.
isThemeLocked	Indique si les utilisateurs peuvent modifier le thème du document.
isUserControl	Indique si le document a été créé ou ouvert par l’utilisateur.
isVbaSigned	Obtient si le projet VBA est signé numériquement.
isWriteReserved	Détermine si le document est protégé par un mot de passe d’écriture.
justificationMode	Spécifie l’ajustement de l’espacement des caractères.
kind	Spécifie le type de mise en forme que Microsoft Word utilise lors de la mise en forme automatique du document.
languageDetected	Indique si Microsoft Word a détecté la langue du texte du document.
listParagraphs	Obtient un `ParagraphCollection` objet qui représente tous les paragraphes numérotés dans le document.
lists	Obtient un `ListCollection` objet qui contient toutes les listes mises en forme dans le document.
listTemplates	Renvoie un `ListTemplateCollection` objet qui représente tous les modèles de liste dans le document.
noLineBreakAfter	Spécifie les caractères kinsoku après lesquels Word n’interrompt pas une ligne.
noLineBreakBefore	Spécifie les caractères kinsoku avant lesquels Word ne sautera pas une ligne.
openEncoding	Récupère l’encodage utilisé pour ouvrir le document.
originalDocumentTitle	Obtient le titre du document original après comparaison avec la ligne noire juridique.
pageSetup	Renvoie un `PageSetup` objet associé au document.
paragraphs	Obtient un `ParagraphCollection` objet qui représente tous les paragraphes du document.
password	Définit un mot de passe qui doit être fourni pour ouvrir le document.
passwordEncryptionAlgorithm	Obtient l’algorithme utilisé pour le chiffrement de mot de passe.
passwordEncryptionKeyLength	Obtient la longueur de clé utilisée pour le chiffrement de mot de passe.
passwordEncryptionProvider	Obtient le nom du fournisseur de chiffrement de mot de passe.
path	Obtient le disque ou le chemin d’accès web au document (à l’exclusion du nom du document).
printRevisions	Indique si les marques de révision sont imprimées avec le document.
properties	Permet d’obtenir les propriétés du document.
protectionType	Obtient le type de protection du document.
readabilityStatistics	Obtient un `ReadabilityStatisticCollection` objet qui représente les statistiques de lisibilité du document.
readingLayoutSizeX	Spécifie la largeur des pages en mode Page de lecture lorsqu’elles sont figées.
readingLayoutSizeY	Spécifie la hauteur des pages en mode Page de lecture lorsqu’elles sont figées.
readingModeIsLayoutFrozen	Indique si les pages en mode Lecture sont figées en raison du balisage manuscrit.
removePersonalInformationOnSave	Indique si Word supprime les informations utilisateur lors de l’enregistrement.
revisedDocumentTitle	Obtient le titre du document révisé après une comparaison juridique-blackline.
revisions	Obtient la collection de révisions qui représente les modifications suivies dans le document.
saved	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.
saveEncoding	Spécifie l’encodage utilisé lors de l’enregistrement du document.
saveFormat	Obtient le format de fichier du document.
sections	Obtient la collection d’objets `Section` du document.
selection	Renvoie un `Selection` objet qui représente la sélection actuelle dans le document.
sensitivityLabel	Renvoie l’étiquette de confidentialité du document.
sentences	Obtient l’objet `RangeScopedCollection` qui représente toutes les phrases du document.
settings	Permet d’obtenir les paramètres du complément dans le document.
spellingErrors	Obtient un `RangeCollection` objet qui représente les mots identifiés comme des fautes d’orthographe dans le document.
storyRanges	Obtient un `RangeCollection` objet qui représente tous les récits dans le document.
styles	Obtient une `StyleCollection` pour le document.
tableOfAuthoritiesCategories	Renvoie un `TableOfAuthoritiesCategoryCollection` objet qui représente le tableau des catégories d’autorités disponibles dans le document.
tables	Récupère un `TableCollection` objet qui représente toutes les tables du document.
tablesOfAuthorities	Renvoie un `TableOfAuthoritiesCollection` objet qui représente toutes les tables d’autorités dans le document.
tablesOfContents	Renvoie un `TableOfContentsCollection` objet qui représente toutes les tables des matières du document.
tablesOfFigures	Renvoie un `TableOfFiguresCollection` objet qui représente tous les tableaux de figures du document.
textEncoding	Spécifie le codage pour l’enregistrement en tant que texte codé.
textLineEnding	Indique comment Word repère les sauts de ligne et de paragraphe dans les fichiers texte.
trackedChangesAreDateAndTimeRemoved	Indique s’il faut supprimer ou stocker les métadonnées de date et d’heure pour les modifications suivies.
trackFormatting	Spécifie s’il faut suivre les modifications de mise en forme lorsque le suivi des modifications est activé.
trackMoves	Indique s’il faut marquer le texte déplacé lorsque le suivi des modifications est activé.
trackRevisions	Indique si les modifications sont suivies dans le document.
type	Obtient le type de document (modèle ou document).
webSettings	Obtient l’objet pour les attributs liés à une `WebSettings` page web.
windows	Obtient la collection d’objets `Word.Window` pour le document.
words	Obtient l’objet `RangeScopedCollection` qui représente chaque mot dans le document.
writePassword	Définit un mot de passe pour enregistrer les modifications apportées au document.
xmlAreAdvancedErrorsShown	Indique si les messages d’erreur sont générés à partir de messages intégrés à Word ou à partir de MSXML (Microsoft XML).
xmlIsXsltUsedWhenSaving	Indique si vous souhaitez enregistrer un document à l’aide d’un langage XSLT (Extensible Stylesheet Language Transformation).
xmlSaveThroughXslt	Spécifie le chemin d’accès et le nom de fichier que XSLT doit appliquer lors de l’enregistrement d’un document.

Méthodes

acceptAllRevisions()	Accepte toutes les modifications suivies dans le document.
acceptAllRevisionsShown()	Accepte toutes les révisions du document qui s’affichent à l’écran.
activate()	Active le document pour qu’il devienne le document actif.
addStyle(name, type)	Ajoute un style dans le document par nom et type.
addStyle(name, type)	Ajoute un style dans le document par nom et type.
addToFavorites()	Crée un raccourci vers le document ou le lien hypertexte et l’ajoute au dossier Favoris .
applyQuickStyleSet(style)	Applique le jeu de styles rapides spécifié au document.
applyQuickStyleSet(style)	Applique le jeu de styles rapides spécifié au document.
applyTheme(name)	Applique le thème spécifié à ce document.
autoFormat()	Met automatiquement en forme le document.
canCheckin()	Retourne `true` si Microsoft Word peut vérifier le document sur un serveur en case activée.
checkConsistencyJapanese()	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.
checkGrammar()	Commence une case activée d’orthographe et de grammaire pour le document.
checkIn(options)	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.
checkInWithVersion(options)	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.
checkSpelling(options)	Commence une case activée de l’orthographe du document.
close(closeBehavior)	Ferme le document actif. Remarque : cette API n’est pas prise en charge dans Word sur le web.
close(closeBehavior)	Ferme le document actif. Remarque : cette API n’est pas prise en charge dans Word sur le web.
closePrintPreview()	Bascule le document de l’aperçu avant impression vers l’affichage précédent.
compare(filePath, documentCompareOptions)	Affiche des marques de révision qui indiquent en quoi le document spécifié diffère d'un autre document.
compareFromBase64(base64File, documentCompareOptions)	Affiche des marques de révision qui indiquent en quoi le document spécifié diffère d'un autre document.
computeStatistics(statistic, includeFootnotesAndEndnotes)	Renvoie une statistique basée sur le contenu du document.
computeStatistics(statistic, includeFootnotesAndEndnotes)	Renvoie une statistique basée sur le contenu du document.
convert()	Convertit le fichier au format le plus récent et active toutes les fonctionnalités.
convertAutoHyphens()	Convertit les traits d’union automatiques en traits d’union manuels.
convertNumbersToText(numberType)	Remplace les champs numliste et numliste du document par du texte.
convertNumbersToText(numberType)	Remplace les champs numliste et numliste du document par du texte.
convertVietnameseDocument(codePageOrigin)	Reconvertit un document vietnamien en format Unicode à l'aide d'une page de codes différente de la page de codes par défaut.
copyStylesFromTemplate(StyleTemplate)	Copie les styles du modèle spécifié vers le document.
countNumberedItems(options)	Renvoie le nombre d’éléments à puces ou numérotés et de champs NumListe dans le document.
deleteAllComments()	Supprime tous les commentaires du document.
deleteAllCommentsShown()	Supprime toutes les révisions du document qui s’affichent à l’écran.
deleteAllInkAnnotations()	Supprime toutes les annotations manuscrites du document.
deleteBookmark(name)	Supprime un signet, s’il existe, du document.
detectLanguage()	Analyse le texte du document pour déterminer la langue.
endReview(options)	Met fin à la révision du fichier qui a été envoyé pour révision.
exportAsFixedFormat(outputFileName, exportFormat, options)	Enregistre le document au format PDF ou XPS.
exportAsFixedFormat(outputFileName, exportFormat, options)	Enregistre le document au format PDF ou XPS.
exportAsFixedFormat2(outputFileName, exportFormat, options)	Enregistre le document au format PDF ou XPS.
exportAsFixedFormat2(outputFileName, exportFormat, options)	Enregistre le document au format PDF ou XPS.
exportAsFixedFormat3(outputFileName, exportFormat, options)	Enregistre le document au format PDF ou XPS avec un balisage amélioré.
exportAsFixedFormat3(outputFileName, exportFormat, options)	Enregistre le document au format PDF ou XPS avec un balisage amélioré.
fitToPages()	Réduit la taille de police du texte juste assez pour que le nombre de pages du document diminue d’une unité.
followHyperlink(options)	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.
freezeLayout()	Corrige la mise en page du document en mode Web.
getAnnotationById(id)	Obtient l’annotation par ID. Génère une `ItemNotFound` erreur si l’annotation est introuvable.
getBookmarkRange(name)	Obtient la plage d’un signet. Génère une `ItemNotFound` erreur si le signet n’existe pas.
getBookmarkRangeOrNullObject(name)	Obtient la plage d’un signet. Si le signet n’existe pas, cette méthode renvoie un objet dont la `isNullObject` propriété est définie sur `true`. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getContentControls(options)	Obtient les contrôles de contenu actuellement pris en charge dans le document.
getCrossReferenceItems(referenceType)	Cette méthode renvoie un tableau d'éléments pouvant être renvoyés en fonction du type de renvoi spécifié.
getCrossReferenceItems(referenceType)	Cette méthode renvoie un tableau d'éléments pouvant être renvoyés en fonction du type de renvoi spécifié.
getEndnoteBody()	Obtient les notes de fin du document dans un seul corps.
getFootnoteBody()	Reçoit les notes de bas de page du document dans un seul corps.
getParagraphByUniqueLocalId(id)	Obtient le paragraphe par son ID local unique. Génère une `ItemNotFound` erreur si la collection est vide.
getRange(options)	Renvoie un `Range` objet en utilisant les positions de début et de fin spécifiées.
getSelection()	Obtient la sélection actuelle du document. Les sélections multiples ne sont pas prises en charge.
getStyles()	Obtient un `StyleCollection` objet qui représente l’ensemble des styles du document.
goTo(options)	Renvoie un `Range` objet qui représente la position de départ de l’élément spécifié, tel qu’une page, un signet ou un champ.
importStylesFromJson(stylesJson, importedStylesConflictBehavior)	Importez des styles à partir d’une chaîne au format JSON.
importStylesFromJson(stylesJson, importedStylesConflictBehavior)	Importez des styles à partir d’une chaîne au format JSON.
insertFileFromBase64(base64File, insertLocation, insertFileOptions)	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.
load(options)	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)	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)	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.
lockServerFile()	Verrouille le fichier sur le serveur pour empêcher sa modification.
makeCompatibilityDefault()	Définit les options de compatibilité.
manualHyphenation()	Démarre la coupure de mots manuelle dans un document, dans un processus ligne par ligne.
merge(fileName, options)	Fusionne d'un document dans un autre les changements signalés par des marques de révision.
post()	Publie le document dans un dossier public de Microsoft Exchange.
presentIt()	Ouvre PowerPoint avec le document Word chargé.
printOut(options)	Imprime tout ou partie du document.
printPreview()	Active le mode Aperçu avant impression.
protect(type, options)	Protège le document contre les modifications non autorisées.
protect(type, options)	Protège le document contre les modifications non autorisées.
redo(times)	Rétablir la dernière action qui a été annulée (inverse la `undo` méthode).
rejectAllRevisions()	Rejette toutes les modifications suivies dans le document.
rejectAllRevisionsShown()	Rejette toutes les révisions du document qui s’affichent à l’écran.
reload()	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.
reloadAs(encoding)	Recharge le document sur la base d’un document HTML, à l’aide de l’encodage de document.
reloadAs(encoding)	Recharge le document sur la base d’un document HTML, à l’aide de l’encodage de document.
removeDocumentInformation(removeDocInfoType)	Supprime les informations sensibles, les propriétés, les commentaires et autres métadonnées du document.
removeDocumentInformation(removeDocInfoType)	Supprime les informations sensibles, les propriétés, les commentaires et autres métadonnées du document.
removeLockedStyles()	Supprime les styles verrouillés du document lorsque des restrictions de mise en forme ont été appliquées dans le document.
removeNumbers(numberType)	Supprime des numéros ou des puces du document.
removeNumbers(numberType)	Supprime des numéros ou des puces du document.
removeTheme()	Supprime le thème actif du document actif.
repaginate()	Repagine l'ensemble du document.
replyWithChanges(options)	Envoie un message électronique à l’auteur du document qui a été envoyé pour révision, l’informant qu’un réviseur a terminé la révision du document.
resetFormFields()	Efface tous les champs du formulaire dans le document et prépare le formulaire à remplir.
returnToLastReadPosition()	Renvoie le document à la dernière position de lecture enregistrée.
runAutoMacro(autoMacro)	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)	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.
save(saveBehavior, fileName)	Enregistre le document.
save(saveBehavior, fileName)	Enregistre le document.
saveAsQuickStyleSet(fileName)	Enregistre le groupe de styles rapides en cours d'utilisation.
search(searchText, searchOptions)	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` .
select()	Sélectionne le contenu du document.
selectContentControlsByTag(tag)	Renvoie tous les contrôles de contenu avec la balise spécifiée.
selectContentControlsByTitle(title)	Renvoie un `ContentControlCollection` objet qui représente tous les contrôles de contenu dans le document avec le titre spécifié.
selectLinkedControls(node)	Renvoie un `ContentControlCollection` objet qui représente tous les contrôles de contenu du document liés au nœud XML personnalisé spécifique.
selectNodes(xPath, options)	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.
selectSingleNode(xPath, options)	Renvoie un `XmlNode` objet qui représente le premier nœud correspondant au paramètre XPath dans le document.
selectUnlinkedControls(stream)	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.
sendFax(address, subject)	Envoie le document sous forme de télécopie, sans interaction de l’utilisateur.
sendFaxOverInternet(options)	Envoie le document à un fournisseur de services de télécopie, qui télécopie le document à un ou plusieurs destinataires spécifiés.
sendForReview(options)	Envoie le document dans un message électronique pour révision par les destinataires spécifiés.
sendMail()	Ouvre une fenêtre de message pour l’envoi du document via Microsoft Exchange.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
setDefaultTableStyle(style, setInTemplate)	Spécifie le style de table à utiliser pour les tables nouvellement créées dans le document.
setPasswordEncryptionOptions(passwordEncryptionProvider, passwordEncryptionAlgorithm, passwordEncryptionKeyLength, passwordEncryptFileProperties)	Définit les options que Microsoft Word utilise pour chiffrer les documents protégés par mot de passe.
toggleFormsDesign()	Active ou désactive le mode Création de formulaire.
toJSON()	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 simple (typé ) `Word.Interfaces.DocumentData`qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
track()	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 entre 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 suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
transformDocument(path, dataOnly)	Applique le fichier XSLT (Extensible Stylesheet Language Transformation) spécifié à ce document et remplace le document avec les résultats.
undo(times)	Annule la dernière action ou une séquence d'actions affichées dans la liste Annuler.
undoClear()	Efface la liste des actions pouvant être annulées dans le document.
unprotect(password)	Supprime la protection du document.
untrack()	Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de 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 libération de mémoire prenne effet.
updateStyles()	Copie dans le document tous les styles du modèle attaché, en écrasant tout style précédent qui porte le même nom.
viewCode()	Affiche la fenêtre de code du contrôle Microsoft ActiveX sélectionné dans le document.
viewPropertyBrowser()	Affiche la fenêtre de propriétés du contrôle Microsoft ActiveX sélectionné dans le document.
webPagePreview()	Affiche un aperçu du document actif tel qu’il serait s’il était enregistré en tant que page web.

Événements

onAnnotationClicked	Se produit lorsque l’utilisateur clique sur une annotation (ou la sélectionne à l’aide de Alt+Bas).
onAnnotationHovered	Se produit lorsque l’utilisateur place le curseur sur une annotation.
onAnnotationInserted	Se produit lorsque l’utilisateur ajoute une ou plusieurs annotations.
onAnnotationPopupAction	Se produit lorsque l’utilisateur effectue une action dans un menu contextuel d’annotation.
onAnnotationRemoved	Se produit lorsque l’utilisateur supprime une ou plusieurs annotations.
onContentControlAdded	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.
onParagraphAdded	Se produit lorsque l’utilisateur ajoute de nouveaux paragraphes.
onParagraphChanged	Se produit lorsque l’utilisateur modifie des paragraphes.
onParagraphDeleted	Se produit lorsque l’utilisateur supprime des paragraphes.

activeTheme

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

readonly activeTheme: string;

Valeur de propriété

string

Remarques

activeThemeDisplayName

Obtient le nom d’affichage du thème actif.

readonly activeThemeDisplayName: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApiDesktop 1.2

activeWindow

Récupère la fenêtre active du document.

readonly activeWindow: Word.Window;

Valeur de propriété

Word.Window

Remarques

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

areFilePropertiesPasswordEncrypted

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

readonly areFilePropertiesPasswordEncrypted: boolean;

Valeur de propriété

boolean

Remarques

areGrammaticalErrorsShown

Indique si les erreurs grammaticales sont signalées par une ligne verte ondulée dans le document.

areGrammaticalErrorsShown: boolean;

Valeur de propriété

boolean

Remarques

areMathDefaultsUsed

Indique 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é

boolean

Remarques

areNewerFeaturesDisabled

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

areNewerFeaturesDisabled: boolean;

Valeur de propriété

boolean

Remarques

areSpellingErrorsShown

Indique si Microsoft Word souligne les fautes d’orthographe dans le document.

areSpellingErrorsShown: boolean;

Valeur de propriété

boolean

Remarques

areStylesUpdatedOnOpen

Indique si les styles de ce document sont mis à jour pour correspondre aux styles du modèle joint chaque fois que le document est ouvert.

areStylesUpdatedOnOpen: boolean;

Valeur de propriété

boolean

Remarques

areTrueTypeFontsEmbedded

Indique si Microsoft Word incorpore des polices TrueType dans le document lors de son enregistrement.

areTrueTypeFontsEmbedded: boolean;

Valeur de propriété

boolean

Remarques

attachedTemplate

Spécifie un Template objet représentant le modèle joint au document.

attachedTemplate: Word.Template;

Valeur de propriété

Word.Template

Remarques

autoHyphenation

Spécifie si la césure automatique est activée pour le document.

autoHyphenation: boolean;

Valeur de propriété

boolean

Remarques

autoSaveOn

Indique si les modifications apportées au document sont automatiquement enregistrées.

autoSaveOn: boolean;

Valeur de propriété

boolean

Remarques

background

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

readonly background: Word.Shape;

Valeur de propriété

Word.Shape

Remarques

bibliography

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

readonly bibliography: Word.Bibliography;

Valeur de propriété

Word.Bibliography

Remarques

body

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

readonly body: Word.Body;

Valeur de propriété

Word.Body

Remarques

bookmarks

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

readonly bookmarks: Word.BookmarkCollection;

Valeur de propriété

Word.BookmarkCollection

Remarques

builtInDocumentProperties

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é

Word.DocumentProperties

Remarques

changeTrackingMode

Spécifie le mode ChangeTracking.

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

Valeur de propriété

Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"

Remarques

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.");
  }
});

characters

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

readonly characters: Word.RangeScopedCollection;

Valeur de propriété

Word.RangeScopedCollection

Remarques

coauthoring

Obtient un Coauthoring objet de gestion de la co-édition dans le document.

readonly coauthoring: Word.Coauthoring;

Valeur de propriété

Word.Coauthoring

Remarques

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthors.yaml

// Gets the coauthoring capabilities and pending-update status of the document.
await Word.run(async (context) => {
  const coauthoring: Word.Coauthoring = context.document.coauthoring;
  coauthoring.load("canCoauthor,canMerge,pendingUpdates");
  await context.sync();

  console.log("Can coauthor:", coauthoring.canCoauthor);
  console.log("Can merge:", coauthoring.canMerge);
  console.log("Pending updates:", coauthoring.pendingUpdates);
});

codeName

Obtient le nom de code du document.

readonly codeName: string;

Valeur de propriété

string

Remarques

comments

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

readonly comments: Word.CommentCollection;

Valeur de propriété

Word.CommentCollection

Remarques

compatibilityMode

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

consecutiveHyphensLimit

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

consecutiveHyphensLimit: number;

Valeur de propriété

number

Remarques

content

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

readonly content: Word.Range;

Valeur de propriété

Word.Range

Remarques

contentControls

Obtient la collection d’objets ContentControl du 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é

Word.ContentControlCollection

Remarques

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Word.RequestContext

currentRsid

Obtient un nombre aléatoire que Word affecte aux modifications apportées au document.

readonly currentRsid: number;

Valeur de propriété

number

Remarques

customDocumentProperties

Obtient une DocumentProperties collection qui représente toutes les propriétés de document personnalisé pour le document.

readonly customDocumentProperties: Word.DocumentProperties;

Valeur de propriété

Word.DocumentProperties

Remarques

customXmlParts

Obtient les parties XML personnalisées du document.

readonly customXmlParts: Word.CustomXmlPartCollection;

Valeur de propriété

Word.CustomXmlPartCollection

Remarques

defaultTabStop

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

defaultTabStop: number;

Valeur de propriété

number

Remarques

defaultTargetFrame

Spécifie le cadre du navigateur pour afficher une page web via un lien hypertexte.

defaultTargetFrame: string;

Valeur de propriété

string

Remarques

documentLibraryVersions

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

readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection;

Valeur de propriété

Word.DocumentLibraryVersionCollection

Remarques

doNotEmbedSystemFonts

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

doNotEmbedSystemFonts: boolean;

Valeur de propriété

boolean

Remarques

encryptionProvider

Spécifie le nom du fournisseur de chiffrement d’algorithme utilisé par Microsoft Word pour chiffrer des documents.

encryptionProvider: string;

Valeur de propriété

string

Remarques

farEastLineBreakLanguage

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

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

Valeur de propriété

Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"

Remarques

farEastLineBreakLevel

Spécifie le niveau de contrôle des sauts de ligne.

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

Valeur de propriété

Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"

Remarques

fields

Récupère un FieldCollection objet qui représente tous les champs du document.

readonly fields: Word.FieldCollection;

Valeur de propriété

Word.FieldCollection

Remarques

formattingIsNextLevelShown

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

formattingIsNextLevelShown: boolean;

Valeur de propriété

boolean

Remarques

formattingIsUserStyleNameShown

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

formattingIsUserStyleNameShown: boolean;

Valeur de propriété

boolean

Remarques

frames

Renvoie un FrameCollection objet qui représente toutes les images du document.

readonly frames: Word.FrameCollection;

Valeur de propriété

Word.FrameCollection

Remarques

fullName

Récupère le nom d’un document, dont le chemin d’accès est inclus.

readonly fullName: string;

Valeur de propriété

string

Remarques

grammaticalErrors

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

readonly grammaticalErrors: Word.RangeCollection;

Valeur de propriété

Word.RangeCollection

Remarques

gridDistanceHorizontal

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 orientale dans le document.

gridDistanceHorizontal: number;

Valeur de propriété

number

Remarques

gridDistanceVertical

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 orientale dans le document.

gridDistanceVertical: number;

Valeur de propriété

number

Remarques

gridIsOriginFromMargin

Indique si la grille de caractères commence à partir du coin supérieur gauche de la page.

gridIsOriginFromMargin: boolean;

Valeur de propriété

boolean

Remarques

gridOriginHorizontal

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

gridOriginHorizontal: number;

Valeur de propriété

number

Remarques

gridOriginVertical

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

gridOriginVertical: number;

Valeur de propriété

number

Remarques

gridSpaceBetweenHorizontalLines

Spécifie l’intervalle entre les quadrillages de caractères horizontaux en mode Page.

gridSpaceBetweenHorizontalLines: number;

Valeur de propriété

number

Remarques

gridSpaceBetweenVerticalLines

Spécifie l’intervalle entre les quadrillages de caractères verticaux en mode Page.

gridSpaceBetweenVerticalLines: number;

Valeur de propriété

number

Remarques

hasPassword

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

readonly hasPassword: boolean;

Valeur de propriété

boolean

Remarques

hasVbProject

Indique si un projet Microsoft Visual Basic pour Applications est associé au document.

readonly hasVbProject: boolean;

Valeur de propriété

boolean

Remarques

hyperlinks

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

readonly hyperlinks: Word.HyperlinkCollection;

Valeur de propriété

Word.HyperlinkCollection

Remarques

hyphenateCaps

Indique si les mots en lettres majuscules peuvent être coupés.

hyphenateCaps: boolean;

Valeur de propriété

boolean

Remarques

hyphenationZone

Spécifie la largeur de la zone de césure, en points.

hyphenationZone: number;

Valeur de propriété

number

Remarques

indexes

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

readonly indexes: Word.IndexCollection;

Valeur de propriété

Word.IndexCollection

Remarques

isAutoFormatOverrideOn

Indique si les options de mise en forme automatique remplacent les restrictions de mise en forme.

isAutoFormatOverrideOn: boolean;

Valeur de propriété

boolean

Remarques

isChartDataPointTracked

Indique 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é

boolean

Remarques

isCompatible

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

isCompatible: boolean;

Valeur de propriété

boolean

Remarques

isFinal

Indique si le document est définitif.

isFinal: boolean;

Valeur de propriété

boolean

Remarques

isFontsSubsetSaved

Indique si Microsoft Word enregistre un sous-ensemble des polices TrueType incorporées avec le document.

isFontsSubsetSaved: boolean;

Valeur de propriété

boolean

Remarques

isFormsDataPrinted

Indique 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é

boolean

Remarques

isFormsDataSaved

Indique si Microsoft Word enregistre les données entrées dans un formulaire sous la forme d’un enregistrement délimité par des tabulations en vue de leur utilisation dans une base de données.

isFormsDataSaved: boolean;

Valeur de propriété

boolean

Remarques

isGrammarChecked

Indique si une case activée grammaticale a été effectuée sur le document.

isGrammarChecked: boolean;

Valeur de propriété

boolean

Remarques

isInAutoSave

Indique 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é

boolean

Remarques

isInFormsDesign

Détermine si le document est en mode Création de formulaire.

readonly isInFormsDesign: boolean;

Valeur de propriété

boolean

Remarques

isKerningByAlgorithm

Indique si le crénage de Word applique les caractères latins à demi-chasse et les signes de ponctuation.

isKerningByAlgorithm: boolean;

Valeur de propriété

boolean

Remarques

isLinguisticDataEmbedded

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

isLinguisticDataEmbedded: boolean;

Valeur de propriété

boolean

Remarques

isMasterDocument

Détermine si ce document est un document master.

readonly isMasterDocument: boolean;

Valeur de propriété

boolean

Remarques

isOptimizedForWord97

Indique si Word optimise le document pour Word 97.

isOptimizedForWord97: boolean;

Valeur de propriété

boolean

Remarques

isPostScriptPrintedOverText

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

isPostScriptPrintedOverText: boolean;

Valeur de propriété

boolean

Remarques

isQuickStyleSetLocked

Indique si les utilisateurs peuvent modifier le jeu de styles rapides.

isQuickStyleSetLocked: boolean;

Valeur de propriété

boolean

Remarques

isReadOnly

Recherche à déterminer 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é

boolean

Remarques

isReadOnlyRecommended

Indique si Microsoft Word affiche une zone de message chaque fois qu’un utilisateur ouvre le document, suggérant de l’ouvrir en lecture seule.

isReadOnlyRecommended: boolean;

Valeur de propriété

boolean

Remarques

isSnappedToGrid

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

isSnappedToGrid: boolean;

Valeur de propriété

boolean

Remarques

isSnappedToShapes

Indique si les formes automatiques ou les caractères d’Asie orientale s’alignent sur un quadrillage invisible à travers d’autres formes.

isSnappedToShapes: boolean;

Valeur de propriété

boolean

Remarques

isSpellingChecked

Indique si l’orthographe a été vérifiée dans l’ensemble du document.

isSpellingChecked: boolean;

Valeur de propriété

boolean

Remarques

isStyleEnforced

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

isStyleEnforced: boolean;

Valeur de propriété

boolean

Remarques

isSubdocument

Détermine si ce document est un sous-document d’un document master.

readonly isSubdocument: boolean;

Valeur de propriété

boolean

Remarques

isThemeLocked

Indique si les utilisateurs peuvent modifier le thème du document.

isThemeLocked: boolean;

Valeur de propriété

boolean

Remarques

isUserControl

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

isUserControl: boolean;

Valeur de propriété

boolean

Remarques

isVbaSigned

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

readonly isVbaSigned: boolean;

Valeur de propriété

boolean

Remarques

isWriteReserved

Détermine si le document est protégé par un mot de passe d’écriture.

readonly isWriteReserved: boolean;

Valeur de propriété

boolean

Remarques

justificationMode

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

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

Valeur de propriété

Word.JustificationMode | "Expand" | "Compress" | "CompressKana"

Remarques

kind

Spécifie le type de mise en forme que Microsoft Word utilise lors de la mise en forme automatique du document.

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

Valeur de propriété

Word.DocumentKind | "NotSpecified" | "Letter" | "Email"

Remarques

languageDetected

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

languageDetected: boolean;

Valeur de propriété

boolean

Remarques

listParagraphs

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

readonly listParagraphs: Word.ParagraphCollection;

Valeur de propriété

Word.ParagraphCollection

Remarques

lists

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

readonly lists: Word.ListCollection;

Valeur de propriété

Word.ListCollection

Remarques

listTemplates

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

readonly listTemplates: Word.ListTemplateCollection;

Valeur de propriété

Word.ListTemplateCollection

Remarques

noLineBreakAfter

Spécifie les caractères kinsoku après lesquels Word n’interrompt pas une ligne.

noLineBreakAfter: string;

Valeur de propriété

string

Remarques

noLineBreakBefore

Spécifie les caractères kinsoku avant lesquels Word ne sautera pas une ligne.

noLineBreakBefore: string;

Valeur de propriété

string

Remarques

openEncoding

Récupère 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

originalDocumentTitle

Obtient le titre du document original après comparaison avec la ligne noire juridique.

readonly originalDocumentTitle: string;

Valeur de propriété

string

Remarques

pageSetup

Renvoie un PageSetup objet associé au document.

readonly pageSetup: Word.PageSetup;

Valeur de propriété

Word.PageSetup

Remarques

Exemples

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

await Word.run(async (context) => {

  // Configure document-wide page settings for a report that will be printed and bound.
  const pageSetup: Word.PageSetup = context.document.pageSetup;
  pageSetup.set({
    paperSize: Word.PaperSize.letter,
    orientation: Word.PageOrientation.portrait,
    topMargin: 72,
    bottomMargin: 72,
    leftMargin: 90,
    rightMargin: 72,
    gutter: 18,
    gutterPosition: Word.GutterPosition.left,
    mirrorMargins: true,
    oddAndEvenPagesHeaderFooter: true
  });

  const sections: Word.SectionCollection = context.document.sections;
  sections.load("items");
  await context.sync();

  // Start the main chapter on an odd-numbered page so it appears on the right in a bound document.
  const chapterPageSetup: Word.PageSetup = sections.items[1].pageSetup;
  chapterPageSetup.sectionStart = Word.SectionStart.oddPage;
  chapterPageSetup.differentFirstPageHeaderFooter = true;

  // Keep the appendix in a separate section, but let it begin on the current page.
  sections.items[2].pageSetup.sectionStart = Word.SectionStart.continuous;

  await context.sync();
  console.log("Applied print and binding settings to the report.");
});

paragraphs

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

readonly paragraphs: Word.ParagraphCollection;

Valeur de propriété

Word.ParagraphCollection

Remarques

password

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

password: string;

Valeur de propriété

string

Remarques

passwordEncryptionAlgorithm

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

readonly passwordEncryptionAlgorithm: string;

Valeur de propriété

string

Remarques

passwordEncryptionKeyLength

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

readonly passwordEncryptionKeyLength: number;

Valeur de propriété

number

Remarques

passwordEncryptionProvider

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

readonly passwordEncryptionProvider: string;

Valeur de propriété

string

Remarques

path

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

readonly path: string;

Valeur de propriété

string

Remarques

printRevisions

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

printRevisions: boolean;

Valeur de propriété

boolean

Remarques

properties

Permet d’obtenir les propriétés du document.

readonly properties: Word.DocumentProperties;

Valeur de propriété

Word.DocumentProperties

Remarques

Jeu 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));
});

protectionType

Obtient le type de protection du document.

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

Valeur de propriété

Remarques

readabilityStatistics

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

readonly readabilityStatistics: Word.ReadabilityStatisticCollection;

Valeur de propriété

Word.ReadabilityStatisticCollection

Remarques

readingLayoutSizeX

Spécifie la largeur des pages en mode Page de lecture lorsqu’elles sont figées.

readingLayoutSizeX: number;

Valeur de propriété

number

Remarques

readingLayoutSizeY

Spécifie la hauteur des pages en mode Page de lecture lorsqu’elles sont figées.

readingLayoutSizeY: number;

Valeur de propriété

number

Remarques

readingModeIsLayoutFrozen

Indique si les pages en mode Lecture sont figées en raison du balisage manuscrit.

readingModeIsLayoutFrozen: boolean;

Valeur de propriété

boolean

Remarques

removePersonalInformationOnSave

Indique si Word supprime les informations utilisateur lors de l’enregistrement.

removePersonalInformationOnSave: boolean;

Valeur de propriété

boolean

Remarques

revisedDocumentTitle

Obtient le titre du document révisé après une comparaison juridique-blackline.

readonly revisedDocumentTitle: string;

Valeur de propriété

string

Remarques

revisions

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

readonly revisions: Word.RevisionCollection;

Valeur de propriété

Word.RevisionCollection

Remarques

saved

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é

boolean

Remarques

saveEncoding

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

saveFormat

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

sections

Obtient la collection d’objets Section du document.

readonly sections: Word.SectionCollection;

Valeur de propriété

Word.SectionCollection

Remarques

selection

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

readonly selection: Word.Selection;

Valeur de propriété

Word.Selection

Remarques

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/55-selection/insert-formula.yaml

// Inserts a formula field without specifying the formula expression.
// Word determines the formula automatically based on adjacent cell values:
// if there are values above the cell, it inserts =SUM(ABOVE);
// if there are values to the left, it inserts =SUM(LEFT).
// The selection must be in a table cell with at least one adjacent cell that contains a value.
await Word.run(async (context) => {
  const options: Word.SelectionInsertFormulaOptions = {
    numberFormat: "#,##0.00",
  };
  context.document.selection.insertFormula(options);
  await context.sync();

  console.log("Inserted formula (auto-determined by Word) with number format.");
});

sensitivityLabel

Notes

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

Renvoie l’étiquette de confidentialité du document.

readonly sensitivityLabel: Word.SensitivityLabel;

Valeur de propriété

Word.SensitivityLabel

Remarques

sentences

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

readonly sentences: Word.RangeScopedCollection;

Valeur de propriété

Word.RangeScopedCollection

Remarques

settings

Permet d’obtenir les paramètres du complément dans le document.

readonly settings: Word.SettingCollection;

Valeur de propriété

Word.SettingCollection

Remarques

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]);
    }
  }
});

spellingErrors

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é

Word.RangeCollection

Remarques

storyRanges

Obtient un RangeCollection objet qui représente tous les récits dans le document.

readonly storyRanges: Word.RangeCollection;

Valeur de propriété

Word.RangeCollection

Remarques

styles

Obtient une StyleCollection pour le document.

readonly styles: Word.StyleCollection;

Valeur de propriété

Word.StyleCollection

Remarques

tableOfAuthoritiesCategories

Renvoie un TableOfAuthoritiesCategoryCollection objet qui représente le tableau des catégories d’autorités disponibles dans le document.

readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection;

Valeur de propriété

Word.TableOfAuthoritiesCategoryCollection

Remarques

tables

Récupère un TableCollection objet qui représente toutes les tables du document.

readonly tables: Word.TableCollection;

Valeur de propriété

Word.TableCollection

Remarques

tablesOfAuthorities

Renvoie un TableOfAuthoritiesCollection objet qui représente toutes les tables d’autorités dans le document.

readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection;

Valeur de propriété

Word.TableOfAuthoritiesCollection

Remarques

tablesOfContents

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

readonly tablesOfContents: Word.TableOfContentsCollection;

Valeur de propriété

Word.TableOfContentsCollection

Remarques

tablesOfFigures

Renvoie un TableOfFiguresCollection objet qui représente tous les tableaux de figures du document.

readonly tablesOfFigures: Word.TableOfFiguresCollection;

Valeur de propriété

Word.TableOfFiguresCollection

Remarques

textEncoding

Spécifie le codage 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

textLineEnding

Indique comment Word repère les sauts de ligne et de paragraphe dans les fichiers texte.

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

Valeur de propriété

Remarques

trackedChangesAreDateAndTimeRemoved

Indique s’il faut supprimer ou stocker les métadonnées de date et d’heure pour les modifications suivies.

trackedChangesAreDateAndTimeRemoved: boolean;

Valeur de propriété

boolean

Remarques

trackFormatting

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é

boolean

Remarques

trackMoves

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

trackMoves: boolean;

Valeur de propriété

boolean

Remarques

trackRevisions

Indique si les modifications sont suivies dans le document.

trackRevisions: boolean;

Valeur de propriété

boolean

Remarques

type

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

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

Valeur de propriété

Word.DocumentType | "Document" | "Template" | "Frameset"

Remarques

webSettings

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

readonly webSettings: Word.WebSettings;

Valeur de propriété

Word.WebSettings

Remarques

Jeu d’API : WordApiDesktop 1.2

windows

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

readonly windows: Word.WindowCollection;

Valeur de propriété

Word.WindowCollection

Remarques

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}`);
});

words

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

readonly words: Word.RangeScopedCollection;

Valeur de propriété

Word.RangeScopedCollection

Remarques

writePassword

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

writePassword: string;

Valeur de propriété

string

Remarques

xmlAreAdvancedErrorsShown

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

xmlAreAdvancedErrorsShown: boolean;

Valeur de propriété

boolean

Remarques

xmlIsXsltUsedWhenSaving

Indique si vous souhaitez enregistrer un document à l’aide d’un langage XSLT (Extensible Stylesheet Language Transformation).

xmlIsXsltUsedWhenSaving: boolean;

Valeur de propriété

boolean

Remarques

xmlSaveThroughXslt

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

xmlSaveThroughXslt: string;

Valeur de propriété

string

Remarques

acceptAllRevisions()

Accepte toutes les modifications suivies dans le document.

acceptAllRevisions(): void;

Retours

void

Remarques

acceptAllRevisionsShown()

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

acceptAllRevisionsShown(): void;

Retours

void

Remarques

activate()

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

activate(): void;

Retours

void

Remarques

addStyle(name, type)

Ajoute un style dans le document par nom et type.

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

Paramètres

name: string

Chaîne représentant le nom du style.

type: Word.StyleType

Type de style, y compris le caractère, la liste, le paragraphe ou le tableau.

Retours

Word.Style

Remarques

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/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.");
});

addStyle(name, type)

Ajoute un style dans le document par nom et type.

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

Paramètres

name: string

Chaîne représentant le nom du style.

type: "Character" | "List" | "Paragraph" | "Table"

Type de style, y compris le caractère, la liste, le paragraphe ou le tableau.

Retours

Word.Style

Remarques

addToFavorites()

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

addToFavorites(): void;

Retours

void

Remarques

applyQuickStyleSet(style)

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

applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void;

Paramètres

style: Word.ApplyQuickStyleSet

Jeu de styles à appliquer.

Retours

void

Remarques

applyQuickStyleSet(style)

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

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

Paramètres

style: "SessionStart" | "Template"

Jeu de styles à appliquer.

Retours

void

Remarques

applyTheme(name)

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

applyTheme(name: string): void;

Paramètres

name: string

Nom du thème.

Retours

void

Remarques

autoFormat()

Met automatiquement en forme le document.

autoFormat(): void;

Retours

void

Remarques

canCheckin()

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

canCheckin(): OfficeExtension.ClientResult<boolean>;

Retours

OfficeExtension.ClientResult<boolean>

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

Remarques

checkConsistencyJapanese()

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

void

Remarques

checkGrammar()

Commence une case activée d’orthographe et de grammaire pour le document.

checkGrammar(): void;

Retours

void

Remarques

checkIn(options)

Notes

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

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

options: Word.DocumentCheckInOptions

Facultatif. Options de configuration pour l’archivage du document.

Retours

void

Remarques

checkInWithVersion(options)

Notes

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

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

options: Word.DocumentCheckInWithVersionOptions

Facultatif. Options de configuration pour l’archivage du document avec le contrôle de version.

Retours

void

Remarques

checkSpelling(options)

Notes

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

Commence une case activée de l’orthographe du document.

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

Paramètres

options: Word.DocumentCheckSpellingOptions

Facultatif. Options de configuration de l’opération de vérification orthographique.

Retours

void

Remarques

close(closeBehavior)

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

closeBehavior: Word.CloseBehavior

Facultatif. Le comportement de fermeture doit être save ou skipSave. La valeur par défaut est save.

Retours

void

Remarques

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

close(closeBehavior)

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

closeBehavior: "Save" | "SkipSave"

Facultatif. Le comportement de fermeture doit être save ou skipSave. La valeur par défaut est save.

Retours

void

Remarques

closePrintPreview()

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

closePrintPreview(): void;

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.1

compare(filePath, documentCompareOptions)

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

filePath: string

Chemin d’accès du document avec lequel le document spécifié est comparé.

documentCompareOptions: Word.DocumentCompareOptions

Facultatif. Les options supplémentaires qui spécifient le comportement de comparaison de document.

Retours

void

Remarques

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.");
});

compareFromBase64(base64File, documentCompareOptions)

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

base64File: string

Contenu codé en Base64 du document avec lequel le document spécifié est comparé.

documentCompareOptions: Word.DocumentCompareOptions

Facultatif. Les options supplémentaires qui spécifient le comportement de comparaison des documents. Notez que l’option compareTarget n’est pas autorisée dans compareTargetSelected cette API.

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.2

computeStatistics(statistic, includeFootnotesAndEndnotes)

Notes

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

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

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

Paramètres

statistic: Word.StatisticType

Type de statistique à retourner.

includeFootnotesAndEndnotes: boolean

Facultatif. Inclure des notes de bas de page et des notes de fin. La valeur par défaut est false.

Retours

Remarques

computeStatistics(statistic, includeFootnotesAndEndnotes)

Notes

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

Renvoie 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

statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters"

Type de statistique à retourner.

includeFootnotesAndEndnotes: boolean

Facultatif. Inclure des notes de bas de page et des notes de fin. La valeur par défaut est false.

Retours

Remarques

convert()

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

convert(): void;

Retours

void

Remarques

convertAutoHyphens()

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

convertAutoHyphens(): void;

Retours

void

Remarques

convertNumbersToText(numberType)

Remplace les champs numliste et numliste du document par du texte.

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

Paramètres

numberType: Word.NumberType

Facultatif. Type de numérotation à convertir.

Retours

void

Remarques

convertNumbersToText(numberType)

Remplace les champs numliste et numliste du document par du texte.

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

Paramètres

numberType: "Paragraph" | "ListNum" | "AllNumbers"

Facultatif. Type de numérotation à convertir.

Retours

void

Remarques

convertVietnameseDocument(codePageOrigin)

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

codePageOrigin: number

Page de codes à utiliser.

Retours

void

Remarques

copyStylesFromTemplate(StyleTemplate)

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

copyStylesFromTemplate(StyleTemplate: string): void;

Paramètres

StyleTemplate: string

Modèle à partir duquel copier les styles.

Retours

void

Remarques

countNumberedItems(options)

Notes

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

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

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

Paramètres

options: Word.DocumentCountNumberedItemsOptions

Facultatif. Options de configuration pour compter les éléments numérotés.

Retours

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

Remarques

deleteAllComments()

Supprime tous les commentaires du document.

deleteAllComments(): void;

Retours

void

Remarques

deleteAllCommentsShown()

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

deleteAllCommentsShown(): void;

Retours

void

Remarques

deleteAllInkAnnotations()

Supprime toutes les annotations manuscrites du document.

deleteAllInkAnnotations(): void;

Retours

void

Remarques

deleteBookmark(name)

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

deleteBookmark(name: string): void;

Paramètres

name: string

Nom de signet qui ne respecte pas la casse.

Retours

void

Remarques

detectLanguage()

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

detectLanguage(): void;

Retours

void

Remarques

endReview(options)

Notes

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

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

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

Paramètres

options: Word.DocumentEndReviewOptions

Facultatif. Options de configuration pour mettre fin au processus de révision.

Retours

void

Remarques

exportAsFixedFormat(outputFileName, exportFormat, options)

Notes

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

Enregistre le document au format PDF ou XPS.

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

Paramètres

outputFileName: string

Nom du fichier de sortie.

exportFormat: Word.ExportFormat

Format d’exportation.

options: Word.DocumentExportAsFixedFormatOptions

Facultatif. Options de configuration de l’opération d’exportation.

Retours

void

Remarques

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/export.yaml

await Word.run(async (context) => {
  // Choose whether the exported PDF uses Word headings, named bookmarks, or neither.
  const bookmarkMode = (document.getElementById("bookmark-mode") as HTMLSelectElement).value;
  let createBookmarks: Word.ExportCreateBookmarks;

  switch (bookmarkMode) {
    case "Headings":
      createBookmarks = Word.ExportCreateBookmarks.headings;
      break;
    case "WordBookmarks":
      createBookmarks = Word.ExportCreateBookmarks.wordBookmarks;
      break;
    default:
      createBookmarks = Word.ExportCreateBookmarks.none;
      break;
  }

  // Export the current document as a PDF saved in your default location, usually Documents.
  const filename = `exported-doc-${bookmarkMode}-${getCurrentDate()}.pdf`;
  console.log(`File name: ${filename}`);
  const options: Word.DocumentExportAsFixedFormatOptions = {
    item: Word.ExportItem.documentContent,
    openAfterExport: true,
    optimizeFor: Word.ExportOptimizeFor.onScreen,
    createBookmarks: createBookmarks,
  };

  // If a file with the same name already exists at the default location, it's silently overwritten.
  context.document.exportAsFixedFormat(filename, Word.ExportFormat.pdf, options);

  await context.sync();
});

exportAsFixedFormat(outputFileName, exportFormat, options)

Notes

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

Enregistre le document au format PDF ou XPS.

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

Paramètres

outputFileName: string

Nom du fichier de sortie.

exportFormat: "Pdf" | "Xps"

Format d’exportation.

options: Word.DocumentExportAsFixedFormatOptions

Facultatif. Options de configuration de l’opération d’exportation.

Retours

void

Remarques

exportAsFixedFormat2(outputFileName, exportFormat, options)

Notes

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

Enregistre le document au format PDF ou XPS.

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

Paramètres

outputFileName: string

Nom du fichier de sortie.

exportFormat: Word.ExportFormat

Format d’exportation (PDF/XPS).

options: Word.DocumentExportAsFixedFormat2Options

Facultatif. Options de configuration de l’opération d’exportation.

Retours

void

Remarques

exportAsFixedFormat2(outputFileName, exportFormat, options)

Notes

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

Enregistre le document au format PDF ou XPS.

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

Paramètres

outputFileName: string

Nom du fichier de sortie.

exportFormat: "Pdf" | "Xps"

Format d’exportation (PDF/XPS).

options: Word.DocumentExportAsFixedFormat2Options

Facultatif. Options de configuration de l’opération d’exportation.

Retours

void

Remarques

exportAsFixedFormat3(outputFileName, exportFormat, options)

Notes

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

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

outputFileName: string

Nom du fichier de sortie.

exportFormat: Word.ExportFormat

Format d’exportation (PDF/XPS).

options: Word.DocumentExportAsFixedFormat3Options

Facultatif. Options de configuration de l’opération d’exportation.

Retours

void

Remarques

exportAsFixedFormat3(outputFileName, exportFormat, options)

Notes

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

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

outputFileName: string

Nom du fichier de sortie.

exportFormat: "Pdf" | "Xps"

Format d’exportation (PDF/XPS).

options: Word.DocumentExportAsFixedFormat3Options

Facultatif. Options de configuration de l’opération d’exportation.

Retours

void

Remarques

fitToPages()

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

fitToPages(): void;

Retours

void

Remarques

followHyperlink(options)

Notes

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

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

options: Word.DocumentFollowHyperlinkOptions

Facultatif. Options de configuration pour suivre le lien hypertexte.

Retours

void

Remarques

freezeLayout()

Corrige la mise en page du document en mode Web.

freezeLayout(): void;

Retours

void

Remarques

getAnnotationById(id)

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

getAnnotationById(id: string): Word.Annotation;

Paramètres

id: string

ID de l’annotation à obtenir.

Retours

Word.Annotation

Remarques

getBookmarkRange(name)

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

name: string

Nom de signet qui ne respecte pas la casse.

Retours

Word.Range

Remarques

getBookmarkRangeOrNullObject(name)

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

getBookmarkRangeOrNullObject(name: string): Word.Range;

Paramètres

name: string

Nom de signet qui ne respecte pas la casse.

Retours

Word.Range

Remarques

getContentControls(options)

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

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

Paramètres

options: Word.ContentControlOptions

Facultatif. Les options qui définissent les contrôles de contenu qui sont renvoyés.

Retours

Word.ContentControlCollection

Remarques

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 renvoyés. Notez qu’une exception sera levée lors de l’utilisation des 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}`
    );
  }
});

getCrossReferenceItems(referenceType)

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

referenceType: Word.ReferenceType

Type de référence.

Retours

Remarques

getCrossReferenceItems(referenceType)

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

referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"

Type de référence.

Retours

Remarques

getEndnoteBody()

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

getEndnoteBody(): Word.Body;

Retours

Word.Body

Remarques

getFootnoteBody()

Reçoit les notes de bas de page du document dans un seul corps.

getFootnoteBody(): Word.Body;

Retours

Word.Body

Remarques

getParagraphByUniqueLocalId(id)

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

id: string

ID local unique au format GUID standard 8-4-4-4-12 sans accolades. Notez que l’ID diffère selon les sessions et les co-auteurs.

Retours

Word.Paragraph

Remarques

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

getRange(options)

Notes

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

Renvoie un Range objet en utilisant les positions de début et de fin spécifiées.

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

Paramètres

options: Word.DocumentRangeOptions

Facultatif. Options de configuration pour spécifier les paramètres de plage.

Retours

Word.Range

Remarques

getSelection()

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

getSelection(): Word.Range;

Retours

Word.Range

Remarques

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.');
});

getStyles()

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

getStyles(): Word.StyleCollection;

Retours

Word.StyleCollection

Remarques

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/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}`);
});

goTo(options)

Notes

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

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

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

Paramètres

options: Word.GoToOptions

Facultatif. Options de configuration permettant de spécifier les goTo paramètres.

Retours

Word.Range

Remarques

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

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

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

Paramètres

stylesJson: string

Chaîne au format JSON représentant les styles.

importedStylesConflictBehavior: Word.ImportedStylesConflictBehavior

Facultatif. Spécifie comment traiter les styles importés portant le même nom que les styles existants dans le document actif. La valeur par défaut est ignore.

Retours

Remarques

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

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

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

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

Paramètres

stylesJson: string

Chaîne au format JSON représentant les styles.

importedStylesConflictBehavior: "Ignore" | "Overwrite" | "CreateNew"

Facultatif. Spécifie comment traiter les styles importés portant le même nom que les styles existants dans le document actif. La valeur par défaut est ignore.

Retours

Remarques

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

insertFileFromBase64(base64File, insertLocation, insertFileOptions)

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

base64File: string

Le contenu codé en Base64 d’un fichier .docx.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

La valeur doit être replace, start, ou end.

insertFileOptions: Word.InsertFileOptions

Facultatif. Propriétés supplémentaires qui doivent être importées dans le document de destination.

Retours

Word.SectionCollection

Remarques

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 adaptée à 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();
});

load(options)

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

options: Word.Interfaces.DocumentLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.Document

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.');
    }
});

load(propertyNames)

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

propertyNames: string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

Word.Document

load(propertyNamesAndPaths)

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

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Word.Document

lockServerFile()

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

lockServerFile(): void;

Retours

void

Remarques

makeCompatibilityDefault()

Définit les options de compatibilité.

makeCompatibilityDefault(): void;

Retours

void

Remarques

manualHyphenation()

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

manualHyphenation(): void;

Retours

void

Remarques

merge(fileName, options)

Notes

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

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

fileName: string

Nom du fichier à fusionner.

options: Word.DocumentMergeOptions

Facultatif. Options de configuration de l’opération de fusion.

Retours

void

Remarques

post()

Publie le document dans un dossier public de Microsoft Exchange.

post(): void;

Retours

void

Remarques

presentIt()

Ouvre PowerPoint avec le document Word chargé.

presentIt(): void;

Retours

void

Remarques

printOut(options)

Notes

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

Imprime tout ou partie du document.

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

Paramètres

options: Word.DocumentPrintOutOptions

Facultatif. Options de configuration de l’opération d’impression.

Retours

void

Remarques

printPreview()

Active le mode Aperçu avant impression.

printPreview(): void;

Retours

void

Remarques

protect(type, options)

Notes

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

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

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

Paramètres

type: Word.ProtectionType

Type de protection.

options: Word.DocumentProtectOptions

Facultatif. Options de configuration de la protection des documents.

Retours

void

Remarques

protect(type, options)

Notes

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

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

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

Paramètres

type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"

Type de protection.

options: Word.DocumentProtectOptions

Facultatif. Options de configuration de la protection des documents.

Retours

void

Remarques

redo(times)

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

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

Paramètres

times: number

Facultatif. Nombre d’actions à rétablir.

Retours

OfficeExtension.ClientResult<boolean>

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

Remarques

rejectAllRevisions()

Rejette toutes les modifications suivies dans le document.

rejectAllRevisions(): void;

Retours

void

Remarques

rejectAllRevisionsShown()

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

rejectAllRevisionsShown(): void;

Retours

void

Remarques

reload()

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

void

Remarques

reloadAs(encoding)

Recharge le document sur la base d’un document HTML, à l’aide de l’encodage de document.

reloadAs(encoding: Word.DocumentEncoding): void;

Paramètres

encoding: Word.DocumentEncoding

Codage à utiliser.

Retours

void

Remarques

reloadAs(encoding)

Recharge le document sur la base d’un document HTML, à l’aide de l’encodage de 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

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"

Codage à utiliser.

Retours

void

Remarques

removeDocumentInformation(removeDocInfoType)

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

removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): void;

Paramètres

removeDocInfoType: Word.RemoveDocInfoType

Type d’informations sur le document à supprimer.

Retours

void

Remarques

removeDocumentInformation(removeDocInfoType)

Supprime les informations sensibles, les propriétés, les commentaires et 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

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

Type d’informations sur le document à supprimer.

Retours

void

Remarques

removeLockedStyles()

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

removeLockedStyles(): void;

Retours

void

Remarques

removeNumbers(numberType)

Supprime des numéros ou des puces du document.

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

Paramètres

numberType: Word.NumberType

Facultatif. Type de numérotation à supprimer.

Retours

void

Remarques

removeNumbers(numberType)

Supprime des numéros ou des puces du document.

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

Paramètres

numberType: "Paragraph" | "ListNum" | "AllNumbers"

Facultatif. Type de numérotation à supprimer.

Retours

void

Remarques

removeTheme()

Supprime le thème actif du document actif.

removeTheme(): void;

Retours

void

Remarques

repaginate()

Repagine l'ensemble du document.

repaginate(): void;

Retours

void

Remarques

replyWithChanges(options)

Notes

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

Envoie un message électronique à 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

options: Word.DocumentReplyWithChangesOptions

Facultatif. Options de configuration pour répondre avec modifications.

Retours

void

Remarques

resetFormFields()

Efface tous les champs du formulaire dans le document et prépare le formulaire à remplir.

resetFormFields(): void;

Retours

void

Remarques

returnToLastReadPosition()

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

returnToLastReadPosition(): OfficeExtension.ClientResult<number>;

Retours

Remarques

runAutoMacro(autoMacro)

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

autoMacro: Word.AutoMacro

La macro automatique à exécuter.

Retours

void

Remarques

runAutoMacro(autoMacro)

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

autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"

La macro automatique à exécuter.

Retours

void

Remarques

save(saveBehavior, fileName)

Enregistre le document.

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

Paramètres

saveBehavior: Word.SaveBehavior

Facultatif. Le comportement enregistrer doit être save ou prompt. La valeur par défaut est save.

fileName: string

Facultatif. Nom du fichier (excluez l’extension de fichier). Prend effet uniquement pour un nouveau document.

Retours

void

Remarques

Remarque : les saveBehavior paramètres et fileName ont été introduits dans WordAPI 1.5.

Exemples

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

save(saveBehavior, fileName)

Enregistre le document.

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

Paramètres

saveBehavior: "Save" | "Prompt"

Facultatif. Le comportement enregistrer doit être save ou prompt. La valeur par défaut est save.

fileName: string

Facultatif. Nom du fichier (excluez l’extension de fichier). Prend effet uniquement pour un nouveau document.

Retours

void

Remarques

Remarque : les saveBehavior paramètres et fileName ont été introduits dans WordAPI 1.5.

saveAsQuickStyleSet(fileName)

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

saveAsQuickStyleSet(fileName: string): void;

Paramètres

fileName: string

Nom du fichier à enregistrer.

Retours

void

Remarques

search(searchText, searchOptions)

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

searchText: string

Texte à rechercher.

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Facultatif. Les options qui définissent le mode d’exécution de la recherche.

Retours

Word.RangeCollection

Remarques

select()

Sélectionne le contenu du document.

select(): void;

Retours

void

Remarques

selectContentControlsByTag(tag)

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

selectContentControlsByTag(tag: string): Word.ContentControlCollection;

Paramètres

tag: string

Valeur de balise pour filtrer les contrôles de contenu.

Retours

Word.ContentControlCollection

Remarques

selectContentControlsByTitle(title)

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

title: string

Le titre des contrôles de contenu.

Retours

Word.ContentControlCollection

Remarques

selectLinkedControls(node)

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

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

Paramètres

node: Word.CustomXmlNode

Le nœud XML personnalisé.

Retours

Word.ContentControlCollection

Remarques

selectNodes(xPath, options)

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

xPath: string

L’expression XPath.

options: Word.SelectNodesOptions

Facultatif. Options de configuration pour la sélection de nœuds.

Retours

Word.XmlNodeCollection

Remarques

selectSingleNode(xPath, options)

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

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

Paramètres

xPath: string

L’expression XPath.

options: Word.SelectSingleNodeOptions

Facultatif. Options de configuration pour la sélection de nœuds.

Retours

Word.XmlNode

Remarques

selectUnlinkedControls(stream)

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

stream: Word.CustomXmlPart

Facultatif. La partie XML personnalisée.

Retours

Word.ContentControlCollection

Remarques

sendFax(address, subject)

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

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

Paramètres

address: string

Adresse de télécopie.

subject: string

Facultatif. Objet de la télécopie.

Retours

void

Remarques

sendFaxOverInternet(options)

Notes

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

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

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

Paramètres

options: Word.DocumentSendFaxOverInternetOptions

Facultatif. Options de configuration pour l’envoi de la télécopie par Internet.

Retours

void

Remarques

sendForReview(options)

Notes

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

Envoie le document dans un message électronique pour révision par les destinataires spécifiés.

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

Paramètres

options: Word.DocumentSendForReviewOptions

Facultatif. Options de configuration pour l’envoi du document pour révision.

Retours

void

Remarques

sendMail()

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

sendMail(): void;

Retours

void

Remarques

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

properties: Word.Interfaces.DocumentUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options: OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

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

properties: Word.Document

Retours

void

setDefaultTableStyle(style, setInTemplate)

Spécifie le style de table à utiliser pour les tables nouvellement créées dans le document.

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

Paramètres

style: string

Style à appliquer.

setInTemplate: boolean

Définir ou non le style dans le modèle.

Retours

void

Remarques

setPasswordEncryptionOptions(passwordEncryptionProvider, passwordEncryptionAlgorithm, passwordEncryptionKeyLength, passwordEncryptFileProperties)

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

passwordEncryptionProvider: string

le fournisseur de chiffrement.

passwordEncryptionAlgorithm: string

L’algorithme de chiffrement.

passwordEncryptionKeyLength: number

Longueur de la clé.

passwordEncryptFileProperties: boolean

Facultatif. Indique s’il faut chiffrer les propriétés du fichier.

Retours

void

Remarques

toggleFormsDesign()

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

toggleFormsDesign(): void;

Retours

void

Remarques

toJSON()

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 simple (typé ) Word.Interfaces.DocumentDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.DocumentData;

Retours

Word.Interfaces.DocumentData

track()

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 entre 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 suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.Document;

Retours

Word.Document

transformDocument(path, dataOnly)

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

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

Paramètres

path: string

Chemin d’accès au fichier XSLT.

dataOnly: boolean

Facultatif. Utiliser uniquement les données.

Retours

void

Remarques

undo(times)

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

times: number

Facultatif. Nombre d’actions à annuler.

Retours

OfficeExtension.ClientResult<boolean>

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

Remarques

undoClear()

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

undoClear(): void;

Retours

void

Remarques

unprotect(password)

Supprime la protection du document.

unprotect(password?: string): void;

Paramètres

password: string

Facultatif. Mot de passe permettant de désactiver la protection du document.

Retours

void

Remarques

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de 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 libération de mémoire prenne effet.

untrack(): Word.Document;

Retours

Word.Document

updateStyles()

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

void

Remarques

viewCode()

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

viewCode(): void;

Retours

void

Remarques

viewPropertyBrowser()

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

viewPropertyBrowser(): void;

Retours

void

Remarques

webPagePreview()

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

webPagePreview(): void;

Retours

void

Remarques

OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>

onAnnotationClicked

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

OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>

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

onAnnotationHovered

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

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

Type d’événement

Remarques

OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>

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

onAnnotationInserted

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

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

Type d’événement

Remarques

OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>

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

onAnnotationPopupAction

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

Jeu 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);
  });
}

onAnnotationRemoved

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

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

Type d’événement

OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>

Remarques

OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>

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}`);
    }
  });
}

onContentControlAdded

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

OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>

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

onParagraphAdded

Se produit lorsque l’utilisateur ajoute de nouveaux paragraphes.

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

Type d’événement

Remarques

OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>

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

onParagraphChanged

Se produit lorsque l’utilisateur modifie des paragraphes.

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

Type d’événement

Remarques

OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>

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

onParagraphDeleted

Se produit lorsque l’utilisateur supprime des paragraphes.

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

Type d’événement

Remarques