Nouveautés de Word’API JavaScript 1.5

  • Article

WordApi 1.5 a ajouté la prise en charge des notes de bas de page, des notes de fin, des événements de contrôle de contenu et de la gestion des styles.

Liste des API

Le tableau suivant répertorie les API dans Word’ensemble de conditions requises de l’API JavaScript 1.5. Pour afficher la documentation de référence des API pour toutes les API prises en charge par Word’ensemble de conditions requises de l’API JavaScript 1.5 ou version antérieure, consultez Word API dans l’ensemble de conditions requises 1.5 ou version antérieure.

Classe Champs Description
Application retrieveStylesFromBase64(base64File : string) Analysez les styles à partir du fichier Base64 du modèle et retournez le format JSON des styles récupérés sous forme de chaîne.
Corps Notes Obtient la collection de notes de fin dans le corps.
Notes Obtient la collection de notes de bas de page dans le corps.
getContentControls(options ?: Word. ContentControlOptions) Obtient les contrôles de contenu actuellement pris en charge dans le corps.
ContentControl Notes Obtient la collection de notes de fin dans le contrôle de contenu.
Notes Obtient la collection de notes de bas de page dans le contrôle de contenu.
getContentControls(options ?: Word. ContentControlOptions) Obtient les contrôles de contenu enfant actuellement pris en charge dans ce contrôle de contenu.
onDataChanged Se produit lorsque les données du contrôle de contenu sont modifiées.
onDeleted Se produit lorsque le contrôle de contenu est supprimé.
onEntered Se produit lorsque le contrôle de contenu est entré.
onExited Se produit lorsque le contrôle de contenu est arrêté, par exemple lorsque le curseur quitte le contrôle de contenu.
onSelectionChanged Se produit lorsque la sélection dans le contrôle de contenu est modifiée.
ContentControlAddedEventArgs eventType Type d’événement.
Id Obtient les ID de contrôle de contenu.
source Source de l'événement.
ContentControlCollection getByChangeTrackingStates(changeTrackingStates : Word. ChangeTrackingState[]) Obtient les contrôles de contenu qui ont l’état de suivi spécifié.
ContentControlDataChangedEventArgs eventType Type d’événement.
Id Obtient les ID de contrôle de contenu.
source Source de l'événement.
ContentControlDeletedEventArgs eventType Type d’événement.
Id Obtient les ID de contrôle de contenu.
source Source de l'événement.
ContentControlEnteredEventArgs 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.
Id Obtient les ID de contrôle de contenu.
source Source de l'événement.
ContentControlOptions types Tableau de types de contrôle de contenu, l’élément doit être « RichText » ou « PlainText ».
ContentControlSelectionChangedEventArgs eventType Type d’événement.
Id Obtient les ID de contrôle de contenu.
source Source de l'événement.
Document addStyle(name : string, type : Word. StyleType) Ajoute un style dans le document par nom et par type.
close(closeBehavior ?: Word. CloseBehavior) Ferme le document actif.
getContentControls(options ?: Word. ContentControlOptions) Obtient les contrôles de contenu actuellement pris en charge dans le document.
getEndnoteBody() Obtient les notes de fin du document dans un corps unique.
getBody() Obtient les notes de bas de page du document dans un seul corps.
getStyles() Obtient un objet StyleCollection qui représente l’ensemble du jeu de styles du document.
insertFileFromBase64(base64File : string, insertLocation : Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « End », insertFileOptions ?: Word. InsertFileOptions) Insère un document dans le document cible à un emplacement spécifique avec des propriétés supplémentaires.
onContentControlAdded Se produit lorsqu’un contrôle de contenu est ajouté.
save(saveBehavior ?: Word. SaveBehavior, fileName ?: string) Enregistre le document.
Champ code Spécifie l’instruction de code du champ.
data Spécifie les données d’un champ « Addin ».
delete() Supprime le champ.
kind Obtient le type du champ.
locked Spécifie si le champ est verrouillé.
select(selectionMode ?: Word. SelectionMode) Sélectionne le champ .
type Obtient le type du champ.
updateResult() Mises à jour le champ.
FieldCollection getByTypes(types : Word. FieldType[]) Obtient la collection d’objets Field, y compris les types de champs spécifiés.
InsertFileOptions importChangeTrackingMode Indique si le mode de suivi des modifications status du document source doit être importé.
importPageColor Indique si la couleur de page et d’autres informations d’arrière-plan du document source doivent être importées.
importParagraphSpacing Indique si l’espacement des paragraphes du document source doit être importé.
importStyles Indique si les styles du document source doivent être importés.
importTheme Indique si le thème du document source doit être importé.
NoteItem body Représente l’objet body de l’élément de note.
delete() Supprime l’élément de note.
getNext() Obtient l’élément de note suivant du même type.
getNextOrNullObject() Obtient l’élément de note suivant du même type.
reference Représente une référence de note de bas de page ou de note de fin dans le document main.
type Représente le type d’élément de note : note de bas de page ou note de fin.
NoteItemCollection getFirst() Obtient le premier élément de note de cette collection.
getFirstOrNullObject() Obtient le premier élément de note de cette collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
Paragraph Notes Obtient la collection de notes de fin dans le paragraphe.
Notes Obtient la collection de notes de bas de page dans le paragraphe.
getContentControls(options ?: Word. ContentControlOptions) Obtient les contrôles de contenu actuellement pris en charge dans le paragraphe.
ParagraphFormat Alignement Spécifie l’alignement des paragraphes spécifiés.
firstLineIndent Spécifie la valeur (en points) d’une première ligne ou d’un retrait négatif.
keepTogether Spécifie si toutes les lignes des paragraphes spécifiés restent sur la même page lorsque Microsoft Word repaginate le document.
keepWithNext Spécifie si le paragraphe spécifié reste sur la même page que le paragraphe qui le suit lorsque Microsoft Word repaginate le document.
leftIndent Spécifie le retrait gauche.
Linespacing Spécifie l’espacement des lignes (en points) pour les paragraphes spécifiés.
lineUnitAfter Spécifie la quantité d’espacement (dans le quadrillage) après les paragraphes spécifiés.
lineUnitBefore Spécifie la quantité d’espacement (dans le quadrillage) avant les paragraphes spécifiés.
mirrorIndents Spécifie si les retraits gauche et droit ont la même largeur.
outlineLevel Spécifie le niveau hiérarchique des paragraphes spécifiés.
rightIndent Spécifie le retrait droit (en points) pour les paragraphes spécifiés.
Spaceafter Spécifie la quantité d’espacement (en points) après le paragraphe ou la colonne de texte spécifié.
spaceBefore Spécifie l’espacement (en points) avant les paragraphes spécifiés.
widowControl Spécifie si les première et dernière lignes du paragraphe spécifié restent sur la même page que le reste du paragraphe lorsque Microsoft Word réagine le document.
Range Notes Obtient la collection de notes de fin dans la plage.
Notes Obtient la collection de notes de bas de page dans la plage.
getContentControls(options ?: Word. ContentControlOptions) Obtient les contrôles de contenu actuellement pris en charge dans la plage.
insertEndnote(insertText ?: string) Insère une note de fin.
insertField(insertLocation : Word. InsertLocation | « Remplacer » | « Démarrer » | « End » | « Avant » | « After », fieldType ? : Word. FieldType, text ?: string, removeFormatting ?: boolean) Insère un champ à l’emplacement spécifié.
insert Footnote(insertText ?: string) Insère une note de bas de page.
Style baseStyle Obtient le nom d’un style existant à utiliser comme mise en forme de base d’un autre style.
Builtin Obtient si le style spécifié est un style intégré.
delete() Supprime le style.
police Obtient un objet de police qui représente la mise en forme des caractères du style spécifié.
Inuse Obtient si le style spécifié est un style intégré qui a été modifié ou appliqué dans le document ou un nouveau style qui a été créé dans le document.
Lié Obtient si un style est un style lié qui peut être utilisé pour la mise en forme des paragraphes et des caractères.
nameLocal Obtient le nom d’un style dans la langue de l’utilisateur.
nextParagraphStyle Obtient le nom du style à appliquer automatiquement à un nouveau paragraphe inséré après un paragraphe mis en forme avec le style spécifié.
paragraphFormat Obtient un objet ParagraphFormat qui représente les paramètres de paragraphe pour le style spécifié.
Priorité Spécifie la priorité.
Quickstyle Spécifie si le style correspond à un style rapide disponible.
type Obtient le type de style.
unhideWhenUsed Spécifie si le style spécifié est rendu visible en tant que style recommandé dans les styles et dans le volet Office Styles de Microsoft Word après son utilisation dans le document.
Visibilité Spécifie si le style spécifié est visible en tant que style recommandé dans la galerie Styles et dans le volet Office Styles.
StyleCollection getByName(name: string) Obtient l’objet de style par son nom.
getByNameOrNullObject(name : string) Si le style correspondant n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true.
getCount() Obtient le nombre de styles dans la collection.
getItem(index : numérique) Obtient un objet de style par son index dans la collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
Tableau Notes Obtient la collection de notes de fin dans le tableau.
Notes Obtient la collection de notes de bas de page dans le tableau.
TableRow Notes Obtient la collection de notes de fin dans la ligne du tableau.
Notes Obtient la collection de notes de bas de page dans la ligne du tableau.

Voir aussi