Partager via

WORD API javaScript en préversion

Les nouvelles API JavaScript Word sont d’abord introduites en « préversion », puis font partie d’un ensemble de conditions requises numérotées spécifiques après que des tests suffisants ont été effectués et que les commentaires des utilisateurs ont été obtenus.

Importante

Notez que les API Word préversion suivantes peuvent être disponibles sur les plateformes suivantes.

  • Word sur Windows
  • Word sur Mac

Word API en préversion ne sont actuellement pas prises en charge sur iPad. Toutefois, plusieurs API peuvent être disponibles uniquement dans Word sur le web.

Remarque

L’aperçu API peut être modifiés et n’est pas destinés à utiliser dans un environnement de production. Nous vous recommandons de les tester uniquement dans les environnements de test et de développement. N’utilisez pas un aperçu d’API dans un environnement de production ou dans les documents commerciaux importants.

Pour utiliser les API disponibles en préversion :

Liste des API

Le tableau suivant répertorie les Word API JavaScript actuellement en préversion. Pour afficher la liste complète de toutes les API JavaScript Word (y compris les API en préversion et les API précédemment publiées), consultez toutes les API Word JavaScript.

Classe Champs Description
Body onCommentAdded Se produit lorsque de nouveaux commentaires sont ajoutés.
onCommentChanged Se produit lorsqu’un commentaire ou sa réponse est modifié.
onCommentDeleted Se produit lorsque les commentaires sont supprimés.
onCommentDeselected Se produit lorsqu’un commentaire est désélectionné.
onCommentSelected Se produit lorsqu’un commentaire est sélectionné.
type Obtient le type du corps.
BookmarkCollection add(name : string, range : Word. Plage) Renvoie un Bookmark objet qui représente un signet ajouté à une plage.
getItem(index : numérique) Obtient un Bookmark objet par son index dans la collection.
BorderUniversalCollection getItem(index : numérique) Obtient un Border objet par son index dans la collection.
CommentDetail id Représente l’ID de ce commentaire.
replyIds Représente les ID des réponses à ce commentaire.
CommentEventArgs changeType Représente la façon dont l’événement commentChanged est déclenché.
commentDetails Obtient le CommentDetail tableau qui contient les ID et les ID de réponse des commentaires impliqués.
source Spécifie la source de l’événement.
type Spécifie le type d’événement.
ConflictCollection getItem(index : numérique) Obtient un Conflict objet par son index dans la collection.
ContentControl onCommentAdded Se produit lorsque de nouveaux commentaires sont ajoutés.
onCommentChanged Se produit lorsqu’un commentaire ou sa réponse est modifié.
onCommentDeselected Se produit lorsqu’un commentaire est désélectionné.
onCommentSelected Se produit lorsqu’un commentaire est sélectionné.
resetState() Réinitialise l’état du contrôle de contenu.
setState(contentControlState : Word. ContentControlState) Définit l’état du contrôle de contenu.
CustomXmlAddValidationErrorOptions clearedOnUpdate Si elle est fournie, spécifie si l’erreur doit être effacée du Word. CustomXmlValidationErrorCollection lorsque le code XML est corrigé et mis à jour.
Errortext S’il est fourni, spécifie le texte d’erreur descriptif.
CustomXmlNodeCollection getItem(index : numérique) Renvoie un CustomXmlNode objet qui représente l’élément spécifié dans la collection.
Customxmlpart errors Obtient un CustomXmlValidationErrorCollection objet qui fournit l’accès à toutes les erreurs de validation XML.
CustomXmlPrefixMappingCollection getItem(index : numérique) Renvoie un CustomXmlPrefixMapping objet qui représente l’élément spécifié dans la collection.
CustomXmlValidationError delete() Supprime cet CustomXmlValidationError objet.
errorCode Obtient un entier représentant l’erreur de validation dans l’objet CustomXmlValidationError .
name Obtient le nom de l’erreur dans l’objet CustomXmlValidationError .
Nœud Obtient le nœud associé à cet CustomXmlValidationError objet, le cas échéant.
text Obtient le texte dans l’objet CustomXmlValidationError .
type Obtient le type d’erreur généré à partir de l’objet CustomXmlValidationError .
CustomXmlValidationErrorCollection add(node : Word. CustomXmlNode, errorName : string, options ?: Word. CustomXmlAddValidationErrorOptions) Ajoute un CustomXmlValidationError objet contenant une erreur de validation XML à l’objet CustomXmlValidationErrorCollection .
getCount() Retourne le nombre d’éléments de la collection.
getItem(index : numérique) Renvoie un CustomXmlValidationError objet qui représente l’élément spécifié dans la collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
Document checkIn(options ?: Word. DocumentCheckInOptions) 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 ?: Word. DocumentCheckInWithVersionOptions) 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 ?: Word. DocumentCheckSpellingOptions) Commence une case activée orthographique pour le document.
computeStatistics(statistic : Word. StatisticType, include FootnotesAndEndnotes ?: boolean) Retourne une statistique basée sur le contenu du document.
countNumberedItems(options ?: Word. DocumentCountNumberedItemsOptions) Renvoie le nombre d’éléments à puces ou numérotés et de champs LISTNUM dans le document.
endReview(options ?: Word. DocumentEndReviewOptions) Met fin à une révision du fichier qui a été envoyé pour révision.
exportAsFixedFormat(outputFileName : string, exportFormat : Word. ExportFormat, options ? : Word. DocumentExportAsFixedFormatOptions) Enregistre le document au format PDF ou XPS.
exportAsFixedFormat2(outputFileName : string, exportFormat : Word. ExportFormat, options ? : Word. DocumentExportAsFixedFormat2Options) Enregistre le document au format PDF ou XPS.
exportAsFixedFormat3(outputFileName : string, exportFormat : Word. ExportFormat, options ? : Word. DocumentExportAsFixedFormat3Options) Enregistre le document au format PDF ou XPS avec un balisage amélioré.
followHyperlink(options ?: Word. DocumentFollowHyperlinkOptions) Cette méthode affiche un document mis en mémoire cache, s'il a déjà été téléchargé.
getRange(options ?: Word. DocumentRangeOptions) Retourne un Range objet en utilisant les positions de caractère de début et de fin spécifiées.
goTo(options ?: Word. GoToOptions) Renvoie un Range objet qui représente la position de début de l’élément spécifié, tel qu’une page, un signet ou un champ.
merge(fileName : string, options ?: Word. DocumentMergeOptions) Fusionne d'un document dans un autre les changements signalés par des marques de révision.
printOut(options ?: Word. DocumentPrintOutOptions) Imprime tout ou partie du document.
protect(type : Word. ProtectionType, options ? : Word. DocumentProtectOptions) Protège le document contre les modifications non autorisées.
replyWithChanges(options ?: Word. DocumentReplyWithChangesOptions) Envoie un e-mail à l’auteur du document qui a été envoyé pour révision, l’informant qu’un réviseur a terminé la révision du document.
sendFaxOverInternet(options ?: Word. DocumentSendFaxOverInternetOptions) Envoie le document à un fournisseur de services de télécopie, qui le faxe à un ou plusieurs destinataires spécifiés.
sendForReview(options ?: Word. DocumentSendForReviewOptions) Envoie le document dans un e-mail pour révision par les destinataires spécifiés.
DocumentCheckInOptions comment S’il est fourni, spécifie un commentaire pour l’opération de case activée.
makePublic S’il est fourni, spécifie s’il faut rendre le document public après case activée-in.
Savechanges S’il est fourni, spécifie s’il faut enregistrer les modifications avant l’archivage.
DocumentCheckInWithVersionOptions comment S’il est fourni, spécifie un commentaire pour l’opération de case activée.
makePublic S’il est fourni, spécifie s’il faut rendre le document public après case activée-in.
Savechanges S’il est fourni, spécifie s’il faut enregistrer les modifications avant l’archivage.
versionType S’il est fourni, spécifie le type de version du case activée.
DocumentCheckSpellingOptions alwaysSuggest S’il est fourni, spécifie s’il faut toujours suggérer des corrections orthographiques.
customDictionary10 S’il est fourni, spécifie un dictionnaire personnalisé supplémentaire à utiliser pour la vérification orthographique.
customDictionary2 S’il est fourni, spécifie un dictionnaire personnalisé supplémentaire à utiliser pour la vérification orthographique.
customDictionary3 S’il est fourni, spécifie un dictionnaire personnalisé supplémentaire à utiliser pour la vérification orthographique.
customDictionary4 S’il est fourni, spécifie un dictionnaire personnalisé supplémentaire à utiliser pour la vérification orthographique.
customDictionary5 S’il est fourni, spécifie un dictionnaire personnalisé supplémentaire à utiliser pour la vérification orthographique.
customDictionary6 S’il est fourni, spécifie un dictionnaire personnalisé supplémentaire à utiliser pour la vérification orthographique.
customDictionary7 S’il est fourni, spécifie un dictionnaire personnalisé supplémentaire à utiliser pour la vérification orthographique.
customDictionary8 S’il est fourni, spécifie un dictionnaire personnalisé supplémentaire à utiliser pour la vérification orthographique.
customDictionary9 S’il est fourni, spécifie un dictionnaire personnalisé supplémentaire à utiliser pour la vérification orthographique.
customDictionary S’il est fourni, spécifie le dictionnaire personnalisé à utiliser pour la vérification orthographique.
ignoreUppercase S’il est fourni, spécifie s’il faut ignorer les mots majuscules lors de la vérification orthographique.
DocumentCountNumberedItemsOptions level S’il est fourni, spécifie le niveau de numérotation à compter.
numberType S’il est fourni, spécifie le type d’éléments numérotés à compter.
DocumentEndReviewOptions includeAttachment S’il est fourni, spécifie s’il faut inclure le document en tant que pièce jointe.
recipients S’il est fourni, spécifie les destinataires à notifier lors de la fin de la révision.
showMessage S’il est fourni, spécifie s’il faut afficher le message avant l’envoi.
subject S’il est fourni, spécifie l’objet de l’e-mail de notification.
DocumentExportAsFixedFormat2Options bitmapMissingFonts S’il est fourni, spécifie s’il faut bitmapr les polices manquantes.
createBookmarks S’il est fourni, spécifie le mode de création de signets.
documentStructureTags S’il est fourni, spécifie s’il faut inclure des balises de structure de document.
fixedFormatExtClassPtr S’il est fourni, spécifie le pointeur de classe d’extension.
from S’il est fourni, spécifie le numéro de page de début.
includeDocProps S’il est fourni, spécifie s’il faut inclure les propriétés du document.
item S’il est fourni, spécifie l’élément à exporter.
keepInformationRightsManagement S’il est fourni, spécifie s’il faut conserver les paramètres de gestion des droits relatifs à l’information (IRM).
openAfterExport S’il est fourni, spécifie s’il faut ouvrir le fichier après l’exportation.
optimizeFor S’il est fourni, spécifie la cible d’optimisation pour l’exportation.
optimizeForImageQuality S’il est fourni, spécifie s’il faut optimiser la qualité de l’image dans le fichier exporté.
range Si elle est fournie, spécifie la plage à exporter.
to S’il est fourni, spécifie le numéro de page de fin.
useIso19005_1 S’il est fourni, spécifie s’il faut utiliser la conformité ISO 19005-1.
DocumentExportAsFixedFormat3Options bitmapMissingFonts S’il est fourni, spécifie s’il faut bitmapr les polices manquantes.
createBookmarks S’il est fourni, spécifie le mode de création de signets.
documentStructureTags S’il est fourni, spécifie s’il faut inclure des balises de structure de document.
fixedFormatExtClassPtr S’il est fourni, spécifie le pointeur de classe d’extension.
from S’il est fourni, spécifie le numéro de page de début.
improveExportTagging S’il est fourni, spécifie pour améliorer le balisage d’exportation pour une meilleure accessibilité.
includeDocProps S’il est fourni, spécifie s’il faut inclure les propriétés du document.
item S’il est fourni, spécifie l’élément à exporter.
keepInformationRightsManagement S’il est fourni, spécifie s’il faut conserver les paramètres de gestion des droits relatifs à l’information (IRM).
openAfterExport S’il est fourni, spécifie s’il faut ouvrir le fichier après l’exportation.
optimizeFor S’il est fourni, spécifie la cible d’optimisation pour l’exportation.
optimizeForImageQuality S’il est fourni, spécifie s’il faut optimiser la qualité de l’image dans le fichier exporté.
range Si elle est fournie, spécifie la plage à exporter.
to S’il est fourni, spécifie le numéro de page de fin.
useIso19005_1 S’il est fourni, spécifie s’il faut utiliser la conformité ISO 19005-1.
DocumentExportAsFixedFormatOptions bitmapMissingFonts S’il est fourni, spécifie s’il faut bitmapr les polices manquantes.
createBookmarks S’il est fourni, spécifie le mode de création de signets.
documentStructureTags S’il est fourni, spécifie s’il faut inclure des balises de structure de document.
fixedFormatExtensionClassPointer S’il est fourni, spécifie le pointeur de classe d’extension.
from S’il est fourni, spécifie le numéro de page de début.
includeDocProps S’il est fourni, spécifie s’il faut inclure les propriétés du document.
item S’il est fourni, spécifie l’élément à exporter.
keepInformationRightsManagement S’il est fourni, spécifie s’il faut conserver les paramètres de gestion des droits relatifs à l’information (IRM).
openAfterExport S’il est fourni, spécifie s’il faut ouvrir le fichier après l’exportation.
optimizeFor S’il est fourni, spécifie la cible d’optimisation pour l’exportation.
range Si elle est fournie, spécifie la plage à exporter.
to S’il est fourni, spécifie le numéro de page de fin.
useIso19005_1 S’il est fourni, spécifie s’il faut utiliser la conformité ISO 19005-1.
DocumentFollowHyperlinkOptions addHistory S’il est fourni, spécifie s’il faut ajouter le lien à l’historique de navigation.
adresse Si elle est fournie, spécifie l’adresse du lien hypertexte à suivre.
extraInfo S’il est fourni, spécifie des informations supplémentaires à transmettre avec la demande.
headerInfo Si elle est fournie, spécifie les informations d’en-tête pour la requête HTTP.
httpMethod Si elle est fournie, spécifie la méthode HTTP à utiliser pour la requête.
newWindow S’il est fourni, spécifie s’il faut ouvrir le lien dans une nouvelle fenêtre.
subAddress Si elle est fournie, spécifie la sous-adresse dans le document.
DocumentMergeOptions addToRecentFiles S’il est fourni, spécifie s’il faut ajouter le document fusionné aux fichiers récents.
detectFormatChanges S’il est fourni, spécifie s’il faut détecter les modifications de format pendant la fusion.
mergeTarget S’il est fourni, spécifie la cible de l’opération de fusion.
useFormattingFrom Si elle est fournie, spécifie la source de mise en forme à utiliser dans la fusion.
DocumentPrintOutOptions activePrinterMacGX S’il est fourni, spécifie le nom de l’imprimante.
Ajouter S’il est fourni, spécifie s’il faut ajouter à un fichier existant.
Fond S’il est fourni, spécifie s’il faut imprimer en arrière-plan.
Rassembler S’il est fourni, spécifie s’il faut assembler les pages.
Copies S’il est fourni, spécifie le nombre de copies à imprimer.
from S’il est fourni, spécifie le numéro de page de début.
item S’il est fourni, spécifie l’élément à imprimer.
manualDuplexPrint S’il est fourni, spécifie s’il faut effectuer une impression recto verso manuellement.
outputFileName S’il est fourni, spécifie le nom du fichier de sortie.
pageType S’il est fourni, spécifie l’ordre des pages.
pages S’il est fourni, spécifie des pages spécifiques à imprimer.
Printtofile S’il est fourni, spécifie s’il faut imprimer dans le fichier.
printZoomColumn S’il est fourni, spécifie le paramètre de colonne de zoom.
printZoomPaperHeight Si elle est fournie, spécifie la hauteur du papier pour l’impression en twips (20 twips = 1 point ; 72 points = 1 pouce).
printZoomPaperWidth Si elle est fournie, spécifie la largeur du papier pour l’impression en twips (20 twips = 1 point ; 72 points = 1 pouce).
printZoomRow S’il est fourni, spécifie le paramètre de ligne de zoom.
range S’il est fourni, spécifie la plage à imprimer.
to S’il est fourni, spécifie le numéro de page de fin.
DocumentProtectOptions enforceStyleLock S’il est fourni, spécifie s’il faut appliquer des restrictions de verrouillage de style.
noReset S’il est fourni, spécifie s’il faut réinitialiser les champs de formulaire lors de la protection du document.
mot de passe S’il est fourni, spécifie le mot de passe à appliquer pour la protection des documents.
useInformationRightsManagement S’il est fourni, spécifie s’il faut utiliser la gestion des droits relatifs à l’information (IRM).
DocumentRangeOptions end Si elle est fournie, spécifie la position du caractère de fin.
start Si elle est fournie, spécifie la position du caractère de départ.
DocumentReplyWithChangesOptions includeAttachment S’il est fourni, spécifie s’il faut inclure le document en tant que pièce jointe.
recipients S’il est fourni, spécifie les destinataires de la réponse.
showMessage S’il est fourni, spécifie s’il faut afficher le message avant l’envoi.
subject S’il est fourni, spécifie l’objet de l’e-mail de réponse.
DocumentSendFaxOverInternetOptions recipients S’il est fourni, spécifie les destinataires de la télécopie.
showMessage S’il est fourni, spécifie s’il faut afficher le message avant l’envoi.
subject S’il est fourni, spécifie l’objet de la télécopie.
DocumentSendForReviewOptions includeAttachment S’il est fourni, spécifie s’il faut inclure le document en tant que pièce jointe.
recipients S’il est fourni, spécifie les destinataires de la demande de révision.
showMessage S’il est fourni, spécifie s’il faut afficher le message avant l’envoi.
subject S’il est fourni, spécifie l’objet de l’e-mail de révision.
GoToOptions count S’il est fourni, spécifie le numéro de l’élément dans le document.
direction Si elle est fournie, spécifie la direction vers laquelle la plage ou la sélection est déplacée.
item S’il est fourni, spécifie le type d’élément vers lequel la plage ou la sélection est déplacée.
name S’il est fourni, spécifie le nom si la item propriété est définie sur Word. Type GoToItem bookmark, comment, fieldou object.
IndexCollection getItem(index : numérique) Obtient un Index objet par son index dans la collection.
ListTemplateAddOptions name S’il est fourni, spécifie le nom du modèle de liste à ajouter.
outlineNumbered S’il est fourni, spécifie s’il faut appliquer la numérotation hiérarchique au nouveau modèle de liste.
ListTemplateCollection add(options ?: Word. ListTemplateAddOptions) Ajoute un nouvel ListTemplate objet.
getItem(index : numérique) Obtient un ListTemplate objet par son index dans la collection.
ListTemplateGalleryCollection getItem(index : numérique) Obtient un ListTemplateGallery objet par son index dans la collection.
Paragraph onCommentAdded Se produit lorsque de nouveaux commentaires sont ajoutés.
onCommentChanged Se produit lorsqu’un commentaire ou sa réponse est modifié.
onCommentDeleted Se produit lorsque les commentaires sont supprimés.
onCommentDeselected Se produit lorsqu’un commentaire est désélectionné.
onCommentSelected Se produit lorsqu’un commentaire est sélectionné.
Range onCommentAdded Se produit lorsque de nouveaux commentaires sont ajoutés.
onCommentChanged Se produit lorsqu’un commentaire ou sa réponse est modifié.
onCommentDeselected Se produit lorsqu’un commentaire est désélectionné.
onCommentSelected Se produit lorsqu’un commentaire est sélectionné.
underline Spécifie le type de soulignement appliqué à la plage.
RangeScopedCollection getItem(index : numérique) Obtient un Range objet par son index dans la collection.
RepeatingSectionContentControl xmlMapping Renvoie un XmlMapping objet qui représente le mappage du contrôle de contenu aux données XML dans le magasin de données du document.
ReviewerCollection getItem(index : numérique) Renvoie un Reviewer objet qui représente l’élément spécifié dans la collection.
RevisionCollection getItem(index : numérique) Renvoie un Revision objet qui représente l’élément spécifié dans la collection.
Selection convertToTable(options ?: Word. SelectionConvertToTableOptions) Convertit le texte d'une plage à un tableau.
goTo(options ?: Word. GoToOptions) Renvoie un Range objet qui représente la zone spécifiée par et options déplace le point d’insertion vers la position de caractère précédant immédiatement l’élément spécifié.
SelectionConvertToTableOptions applyBorders S’il est fourni, spécifie s’il faut appliquer des bordures à la table au format spécifié.
applyColor S’il est fourni, spécifie s’il faut appliquer une mise en forme de couleur à la table du format spécifié.
applyFirstColumn Si elle est fournie, spécifie s’il faut appliquer une mise en forme spéciale à la première colonne du format spécifié.
applyFont S’il est fourni, spécifie s’il faut appliquer une mise en forme de police à la table du format spécifié.
applyHeadingRows Si elle est fournie, spécifie s’il faut mettre en forme la première ligne en tant que ligne d’en-tête du format spécifié.
applyLastColumn Si elle est fournie, spécifie s’il faut appliquer une mise en forme spéciale à la dernière colonne du format spécifié.
applyLastRow S’il est fourni, spécifie s’il faut appliquer une mise en forme spéciale à la dernière ligne du format spécifié.
applyShading S’il est fourni, spécifie s’il faut appliquer l’ombrage à la table au format spécifié.
ajustement automatique S’il est fourni, spécifie s’il faut redimensionner automatiquement la table pour l’adapter au contenu.
autoFitBehavior S’il est fourni, spécifie le comportement d’ajustement automatique pour la table.
defaultTableBehavior Si elle est fournie, spécifie si Microsoft Word redimensionne automatiquement les cellules d’un tableau pour s’adapter au contenu.
format S’il est fourni, spécifie un format prédéfini à appliquer à la table.
initialColumnWidth Si elle est fournie, spécifie la largeur initiale de chaque colonne de la table, en points.
numColumns S’il est fourni, spécifie le nombre de colonnes dans la table.
numRows S’il est fourni, spécifie le nombre de lignes dans la table.
Séparateur S’il est fourni, spécifie le caractère utilisé pour séparer le texte en cellules.
SourceCollection getItem(index : numérique) Obtient un Source par son index dans la collection.
Style description Obtient la description du style.
TabStopCollection getItem(index : numérique) Obtient un TabStop objet par son index dans la collection.
Window state Spécifie l’état de la fenêtre de document ou de la fenêtre de tâche.
Xmlnode type Obtient le type de nœud.
value Spécifie la valeur de ce nœud XML.
XmlNodeCollection getItem(index : numérique) Obtient un XmlNode objet par son index dans la collection.

Voir aussi

  • Last updated on