WORD API javaScript en préversion

  • Article

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 également être disponibles dans Word sur le web. Pour les API disponibles uniquement dans Word sur le web, consultez la liste des API web uniquement.

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 API JavaScript Word actuellement en préversion, à l’exception de celles qui sont disponibles uniquement dans Word sur le web. 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
AnnotationPopupActionEventArgs action Spécifie l’action choisie dans le menu contextuel.
critiqueSuggestion Spécifie la suggestion acceptée (renseignée uniquement lors de l’acceptation d’une suggestion critique).
id Spécifie l’ID d’annotation pour lequel l’événement a été déclenché.
Border color Spécifie la couleur de la bordure.
location Obtient l’emplacement de la bordure.
type Spécifie le type de bordure pour la bordure.
visible Spécifie si la bordure est visible.
width Spécifie la largeur de la bordure.
BorderCollection getByLocation(borderLocation : Word.BorderLocation.top | Word. BorderLocation.left | Word. BorderLocation.bottom | Word. BorderLocation.right | Word. BorderLocation.insideHorizontal | Word. BorderLocation.insideVertical | « Top » | « Left » | « Bottom » | « Right » | « InsideHorizontal » | « InsideVertical ») Obtient la bordure qui a l’emplacement spécifié.
getFirst() Obtient la première bordure de cette collection.
getFirstOrNullObject() Obtient la première bordure de cette collection.
getItem(index : numérique) Obtient un objet Border par son index dans la collection.
insideBorderColor Spécifie la couleur 24 bits des bordures intérieures.
insideBorderType Spécifie le type de bordure des bordures intérieures.
insideBorderWidth Spécifie la largeur des bordures intérieures.
items Obtient l’élément enfant chargé dans cette collection de sites.
outsideBorderColor Spécifie la couleur 24 bits des bordures extérieures.
outsideBorderType Spécifie le type de bordure des bordures extérieures.
outsideBorderWidth Spécifie la largeur des bordures extérieures.
ContentControlAddedEventArgs eventType Type d’événement.
ContentControlDataChangedEventArgs eventType Type d’événement.
ContentControlDeletedEventArgs eventType Type d’événement.
ContentControlEnteredEventArgs eventType Type d’événement.
ContentControlEventArgs contentControl Objet qui a déclenché l’événement.
eventType Type d’événement.
Id Obtient les ID de contrôle de contenu.
source Source de l'événement.
ContentControlExitedEventArgs eventType Type d’événement.
ContentControlSelectionChangedEventArgs eventType Type d’événement.
Critique popupOptions Spécifie le comportement du menu contextuel pour la critique.
CritiquePopupOptions brandingTextResourceId Obtient l’ID de ressource manifeste de la chaîne à utiliser pour la personnalisation.
subtitleResourceId Obtient l’ID de ressource de manifeste de la chaîne à utiliser comme sous-titre.
Suggestions Obtient les suggestions à afficher dans le menu contextuel critique.
titleResourceId Obtient l’ID de ressource de manifeste de la chaîne à utiliser comme titre.
Document compare(filePath : string, documentCompareOptions ?: Word. DocumentCompareOptions) Affiche des marques de révision qui indiquent en quoi le document spécifié diffère d'un autre document.
onAnnotationPopupAction Se produit lorsque l’utilisateur effectue une action dans un menu contextuel d’annotation.
DocumentCompareOptions addToRecentFiles True ajoute le document à la liste des derniers fichiers utilisés dans le menu fichier.
authorName Nom du réviseur associé aux différences générées par la comparaison.
compareTarget Le document cible pour la comparaison.
detectFormatChanges True : (par défaut) pour que la comparaison détecte les modifications de format.
ignoreAllComparisonWarnings True pour comparer les documents sans notifier de problèmes à un utilisateur.
removeDateAndTime True supprime les informations de date et date et heure du suivi des modifications dans l'objet Document renvoyé.
removePersonalInformation True supprime toutes les informations utilisateur des commentaires, des révisions et de la boîte de dialogue propriétés dans l’objet Document retourné.
Champ showCodes Spécifie si les codes de champ sont affichés pour le champ spécifié.
Font hidden Spécifie une valeur qui indique si la police est marquée comme masquée.
InlinePicture imageFormat Obtient le format de l’image incluse.
List getLevelFont(level : number) Obtient la police de la puce, du nombre ou de l’image au niveau spécifié dans la liste.
getLevelPicture(level : number) Obtient la représentation sous forme de chaîne encodée en Base64 de l’image au niveau spécifié dans la liste.
resetLevelFont(level : number, resetFontName ?: boolean) Réinitialise la police de la puce, du numéro ou de l’image au niveau spécifié dans la liste.
setLevelPicture(level : number, base64EncodedImage ?: string) Définit l’image au niveau spécifié dans la liste.
ListLevel Alignement Spécifie l’alignement horizontal du niveau de liste.
police Obtient un objet Font qui représente la mise en forme des caractères de l’objet spécifié.
linkedStyle Spécifie le nom du style lié à l’objet de niveau liste spécifié.
numberFormat Spécifie le format de nombre pour le niveau de liste spécifié.
numberPosition Spécifie la position (en points) du numéro ou de la puce de l’objet de niveau liste spécifié.
numberStyle Spécifie le style numérique de l’objet de niveau liste.
resetOnHigher Spécifie le niveau de liste qui doit apparaître avant que le niveau de liste spécifié redémarre la numérotation à 1.
startAt Spécifie le numéro de départ de l’objet de niveau liste spécifié.
tabPosition Spécifie la position de la tabulation pour l’objet de niveau liste spécifié.
textPosition Spécifie la position (en points) de la deuxième ligne de texte d’habillage pour l’objet de niveau liste spécifié.
trailingCharacter Spécifie le caractère inséré après le nombre du niveau de liste spécifié.
ListLevelCollection getFirst() Obtient le premier niveau de liste de cette collection.
getFirstOrNullObject() Obtient le premier niveau de liste de cette collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
ListTemplate listLevels Obtient une collection ListLevels qui représente tous les niveaux du ListTemplate spécifié.
outlineNumbered Spécifie si l’objet ListTemplate spécifié est numéroté par un plan.
ParagraphAddedEventArgs type Type d’événement.
ParagraphChangedEventArgs type Type d’événement.
ParagraphDeletedEventArgs type Type d’événement.
Range highlight() Met en surbrillance la plage temporairement sans modifier le contenu du document.
removeHighlight() Supprime la mise en surbrillance ajoutée par la fonction Highlight, le cas échéant.
Shading foregroundPatternColor Spécifie la couleur du premier plan de l’objet.
Texture Spécifie la texture d’ombrage de l’objet.
Style Borders Spécifie un objet BorderCollection qui représente toutes les bordures du style spécifié.
description Obtient la description du style spécifié.
listTemplate Obtient un objet ListTemplate qui représente la mise en forme de liste pour l’objet Style spécifié.
TableRow insertContentControl() Insère un contrôle de contenu sur la ligne.
TableStyle Alignement Spécifie l’alignement de la table par rapport à la marge de page.
allowBreakAcrossPage Spécifie si les lignes des tableaux sont mises en forme avec un saut de style spécifié sur les pages.

Liste des API web uniquement

Le tableau suivant répertorie les API JavaScript Word actuellement en préversion uniquement dans Word sur le web. 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
Corps 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é.
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 de modification de commentaire est déclenché.
commentDetails Obtient le tableau CommentDetail qui contient les ID et les ID de réponse des commentaires impliqués.
source Source de l'événement.
type Type d’événement.
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é.
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é.

Voir aussi