Nouveautés de l’API JavaScript 1.3 pour Word

  • Article

WordApi 1.3 a ajouté une prise en charge supplémentaire des contrôles de contenu et des paramètres au niveau du document.

Liste des API

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

Classe Champs Description
Application createDocument(base64File ?: string) Crée un document à l’aide d’un fichier .docx encodé en Base64 facultatif.
Body getRange(rangeLocation ?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | Word. RangeLocation.content | « Entier » | « Démarrer » | « End » | « After » | « Content ») Obtient la totalité du corps, ou le point de début ou de fin du corps, sous la forme d’une plage.
insertTable(rowCount : number, columnCount : number, insertLocation : Word. InsertLocation.start | Word. InsertLocation.end | « Démarrer » | « End », values ?: string[][]) Insère un tableau avec le nombre spécifié de lignes et de colonnes.
lists Obtient la collection d’objets list dans le corps.
parentBody Obtient le corps parent du corps.
parentBodyOrNullObject Obtient le corps parent du corps.
parentContentControlOrNullObject Obtient le contrôle de contenu qui contient le corps.
parentSection Obtient la section parent du corps.
parentSectionOrNullObject Obtient la section parent du corps.
styleBuiltIn Spécifie le nom de style intégré pour le corps.
Tables Obtient la collection d’objets table dans le corps.
type Obtient le type du corps.
ContentControl getRange(rangeLocation ?: Word. RangeLocation | « Entier » | « Démarrer » | « End » | « Avant » | « After » | « Content ») Obtient le contrôle de contenu entier, ou le point de début ou de fin du contrôle de contenu, sous la forme d’une plage.
getTextRanges(endingMarks : string[], trimSpacing ?: boolean) Obtient les plages de texte dans le contrôle de contenu à l’aide de signes de ponctuation et/ou d’autres marques de fin.
insertTable(rowCount : number, columnCount : number, insertLocation : Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | « Démarrer » | « End » | « Avant » | « After », values ?: string[][]) Insère un tableau avec le nombre spécifié de lignes et de colonnes dans un contrôle de contenu ou à proximité de celui-ci.
lists Obtient la collection d’objets list du contrôle de contenu.
parentBody Obtient le corps parent du contrôle de contenu.
parentContentControlOrNullObject Obtient le contrôle de contenu qui contient le contrôle de contenu spécifié.
parentTable Obtient le tableau qui contient le contrôle de contenu.
parentTableCell Obtient la cellule de tableau qui contient le contrôle de contenu.
parentTableCellOrNullObject Obtient la cellule de tableau qui contient le contrôle de contenu.
parentTableOrNullObject Obtient le tableau qui contient le contrôle de contenu.
split(delimiters : string[], multiParagraphs ?: boolean, trimDelimiters ?: boolean, trimSpacing ?: boolean) Fractionne le contrôle de contenu en plages enfants à l’aide de délimiteurs.
styleBuiltIn Spécifie le nom de style intégré pour le contrôle de contenu.
Sous-type Obtient le sous-type du contrôle de contenu.
Tables Obtient la collection d’objets table du contrôle de contenu.
ContentControlCollection getByIdOrNullObject(id : number) Obtient un contrôle de contenu par son identificateur.
getByTypes(types : Word. ContentControlType[]) Obtient les contrôles de contenu qui ont les types spécifiés.
getFirst() Obtient le premier contrôle de contenu de cette collection.
getFirstOrNullObject() Obtient le premier contrôle de contenu de cette collection.
CustomProperty delete() Supprime la propriété personnalisée.
key Obtient la clé de la propriété personnalisée.
type Obtient le type de valeur de la propriété personnalisée.
value Spécifie la valeur de la propriété personnalisée.
CustomPropertyCollection add(key : string, value : any) Crée une nouvelle propriété personnalisée ou en définit une existante.
deleteAll() Supprime toutes les propriétés personnalisées de cette collection.
getCount() Obtient le nombre des propriétés personnalisées.
getItem(key: string) Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse.
getItemOrNullObject(key: string) Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse.
items Obtient l’élément enfant chargé dans cette collection de sites.
Document properties Obtient les propriétés du document.
DocumentCreated open() Ouvre le document.
DocumentProperties applicationName Obtient le nom d’application du document.
auteur Spécifie l’auteur du document.
catégorie Spécifie la catégorie du document.
comments Spécifie le champ Commentaires dans les métadonnées du document.
company Spécifie la société du document.
creationDate Obtient la date de création du document.
customProperties Obtient la collection de propriétés personnalisées du document.
format Spécifie le format du document.
Mots-clés Spécifie les mots clés du document.
lastAuthor Obtient le dernier auteur du document.
lastPrintDate Obtient la dernière date d’impression du document.
lastSaveTime Obtient la dernière heure d’enregistrement du document.
gérant Spécifie le gestionnaire du document.
revisionNumber Obtient le numéro de révision du document.
sécurité Obtient les paramètres de sécurité du document.
subject Spécifie l’objet du document.
template Obtient le modèle du document.
title Spécifie le titre du document.
InlinePicture getNext() Obtient l’image insérée suivante.
getNextOrNullObject() Obtient l’image insérée suivante.
getRange(rangeLocation ?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | « Entier » | « Démarrer » | « Fin ») Obtient l’image, ou le point de départ ou de fin de l’image, sous la forme d’une plage.
parentContentControlOrNullObject Obtient le contrôle de contenu qui contient l’image incluse.
parentTable Obtient le tableau qui contient l’image insérée.
parentTableCell Obtient la cellule de tableau qui contient l’image insérée.
parentTableCellOrNullObject Obtient la cellule de tableau qui contient l’image insérée.
parentTableOrNullObject Obtient le tableau qui contient l’image insérée.
InlinePictureCollection getFirst() Obtient la première image insérée de cette collection.
getFirstOrNullObject() Obtient la première image insérée de cette collection.
List getLevelParagraphs(level : number) Obtient les paragraphes qui figurent au niveau spécifié de la liste.
getLevelString(level : number) Obtient la puce, le nombre ou l’image au niveau spécifié sous forme de chaîne.
id Obtient l’ID de la liste.
insertParagraph(paragraphText : string, insertLocation : Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | « Démarrer » | « End » | « Avant » | « After ») Insère un paragraphe à l’emplacement spécifié.
levelExistences Vérifie si chacun des 9 niveaux existe dans la liste.
levelTypes Obtient les 9 types de niveau de la liste.
paragraphs Obtient les paragraphes de la liste.
setLevelAlignment(level : number, alignment : Word. Alignement) Définit l’alignement de la puce, du nombre ou de l’image au niveau spécifié dans la liste.
setLevelBullet(level : number, listBullet : Word. ListBullet, charCode ?: number, fontName ?: string) Définit le format de puce au niveau spécifié de la liste.
setLevelIndents(level : number, textIndent : number, bulletNumberPictureIndent : number) Définit les deux retraits du niveau spécifié de la liste.
setLevelNumbering(level : number, listNumbering : Word. ListNumbering, formatString ?: Array<string | number>) Définit le format de numérotation du niveau spécifié de la liste.
setLevelStartingNumber(level : number, startingNumber : number) Définit le numéro de départ du niveau spécifié de la liste.
ListCollection getById(id: number) Obtient une liste par son identificateur.
getByIdOrNullObject(id : number) Obtient une liste par son identificateur.
getFirst() Obtient la première liste de cette collection.
getFirstOrNullObject() Obtient la première liste de cette collection.
getItem(id : number) Obtient un objet de liste par son ID.
items Obtient l’élément enfant chargé dans cette collection de sites.
ListItem getAncestor(parentOnly ?: boolean) Obtient le parent de l’élément de liste, ou l’ancêtre le plus proche si le parent n’existe pas.
getAncestorOrNullObject(parentOnly ?: boolean) Obtient le parent de l’élément de liste, ou l’ancêtre le plus proche si le parent n’existe pas.
getDescendants(directChildrenOnly ?: boolean) Obtient tous les éléments de liste descendants de l’élément de liste.
level Spécifie le niveau de l’élément dans la liste.
listString Obtient la puce, le nombre ou l’image de l’élément de liste sous forme de chaîne.
siblingIndex Obtient le numéro d’ordre de l’élément de liste relativement à ses frères.
Paragraph attachToList(listId : number, level : number) Permet au paragraphe de rejoindre une liste existante au niveau spécifié.
detachFromList() Déplace ce paragraphe en dehors de la liste, si le paragraphe est un élément de liste.
getNext() Obtient le paragraphe suivant.
getNextOrNullObject() Obtient le paragraphe suivant.
getPrevious() Obtient le paragraphe précédent.
getPreviousOrNullObject() Obtient le paragraphe précédent.
getRange(rangeLocation ?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | Word. RangeLocation.content | « Entier » | « Démarrer » | « End » | « After » | « Content ») Obtient le paragraphe entier, ou le point de début ou de fin du paragraphe, sous la forme d’une plage.
getTextRanges(endingMarks : string[], trimSpacing ?: boolean) Obtient les plages de texte dans le paragraphe à l’aide de signes de ponctuation et/ou d’autres marques de fin.
insertTable(rowCount : number, columnCount : number, insertLocation : Word. InsertLocation.before | Word. InsertLocation.after | « Avant » | « After », values ?: string[][]) Insère un tableau avec le nombre spécifié de lignes et de colonnes.
isLastParagraph Indique que le paragraphe est le dernier au sein de son corps parent.
isListItem Vérifie si le paragraphe est un élément de liste.
list Obtient la liste à laquelle ce paragraphe appartient.
listItem Obtient l’élément de liste du paragraphe.
listItemOrNullObject Obtient l’élément de liste du paragraphe.
listOrNullObject Obtient la liste à laquelle ce paragraphe appartient.
parentBody Obtient le corps parent du paragraphe.
parentContentControlOrNullObject Obtient le contrôle de contenu qui contient le paragraphe.
parentTable Obtient le tableau qui contient le paragraphe.
parentTableCell Obtient la cellule de tableau qui contient le paragraphe.
parentTableCellOrNullObject Obtient la cellule de tableau qui contient le paragraphe.
parentTableOrNullObject Obtient le tableau qui contient le paragraphe.
split(delimiters : string[], trimDelimiters ?: boolean, trimSpacing ?: boolean) Divise le paragraphe en plages enfants à l’aide de délimiteurs.
startNewList() Démarre une nouvelle liste avec ce paragraphe.
styleBuiltIn Spécifie le nom de style intégré pour le paragraphe.
tableNestingLevel Obtient le niveau de tableau du paragraphe.
ParagraphCollection getFirst() Obtient le premier paragraphe de cette collection.
getFirstOrNullObject() Obtient le premier paragraphe de cette collection.
getLast() Obtient le dernier paragraphe dans cette collection.
getLastOrNullObject() Obtient le dernier paragraphe dans cette collection.
Range compareLocationWith(range : Word. Plage) Compare l’emplacement de la plage à celui d’une autre plage.
expandTo(range : Word. Plage) Renvoie une nouvelle plage qui s’étend dans les deux directions à partir de cette plage pour couvrir une autre plage.
expandToOrNullObject(range : Word. Plage) Renvoie une nouvelle plage qui s’étend dans les deux directions à partir de cette plage pour couvrir une autre plage.
getHyperlinkRanges() Obtient les plages enfants d’un lien hypertexte au sein de la plage.
getNextTextRange(endingMarks : string[], trimSpacing ?: boolean) Obtient la plage de texte suivante à l’aide de signes de ponctuation et/ou d’autres marques de fin.
getNextTextRangeOrNullObject(endingMarks : string[], trimSpacing ?: boolean) Obtient la plage de texte suivante à l’aide de signes de ponctuation et/ou d’autres marques de fin.
getRange(rangeLocation ?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | Word. RangeLocation.content | « Entier » | « Démarrer » | « End » | « After » | « Content ») Clone la plage ou obtient le point de début ou de fin de la plage sous la forme d’une nouvelle plage.
getTextRanges(endingMarks : string[], trimSpacing ?: boolean) Obtient les plages enfants de texte dans la plage à l’aide de signes de ponctuation et/ou d’autres marques de fin.
lien hypertexte Obtient le premier lien hypertexte de la plage ou définit un lien hypertexte sur la plage.
insertTable(rowCount : number, columnCount : number, insertLocation : Word. InsertLocation.before | Word. InsertLocation.after | « Avant » | « After », values ?: string[][]) Insère un tableau avec le nombre spécifié de lignes et de colonnes.
intersectWith(range : Word. Plage) Retourne une nouvelle plage en tant qu’intersection de cette plage avec une autre.
intersectWithOrNullObject(range : Word. Plage) Retourne une nouvelle plage en tant qu’intersection de cette plage avec une autre.
isEmpty Vérifie si la longueur de la plage est zéro.
lists Obtient la collection d’objets de liste figurant dans la plage.
parentBody Obtient le corps parent de la plage.
parentContentControlOrNullObject Obtient le contrôle de contenu actuellement pris en charge qui contient la plage.
parentTable Obtient le tableau qui contient la plage.
parentTableCell Obtient la cellule de tableau qui contient la plage.
parentTableCellOrNullObject Obtient la cellule de tableau qui contient la plage.
parentTableOrNullObject Obtient le tableau qui contient la plage.
split(delimiters : string[], multiParagraphs ?: boolean, trimDelimiters ?: boolean, trimSpacing ?: boolean) Divise la plage en plages enfants à l’aide de délimiteurs.
styleBuiltIn Spécifie le nom de style intégré pour la plage.
Tables Obtient la collection d’objets de table dans la plage.
RangeCollection getFirst() Obtient la première plage de cette collection.
getFirstOrNullObject() Obtient la première plage de cette collection.
RequestContext application [Ensemble d’API : WordApi 1.3] *
Section getNext() Obtient la section suivante.
getNextOrNullObject() Obtient la section suivante.
SectionCollection getFirst() Obtient la première section de cette collection.
getFirstOrNullObject() Obtient la première section de cette collection.
Style
Tableau addColumns(insertLocation : Word. InsertLocation.start | Word. InsertLocation.end | « Démarrer » | « End », columnCount : number, values ?: string[][]) Ajoute des colonnes au début ou à la fin du tableau, en utilisant la première ou la dernière colonne existante en tant que modèle.
addRows(insertLocation : Word. InsertLocation.start | Word. InsertLocation.end | « Démarrer » | « End », rowCount : number, values ?: string[][]) Ajoute des lignes au début ou à la fin du tableau, en utilisant la première ou la dernière ligne existante en tant que modèle.
alignement Spécifie l’alignement de la table par rapport à la colonne de page.
autoFitWindow() Ajuste automatiquement les colonnes du tableau à la largeur de la fenêtre.
clear() Efface le contenu du tableau.
delete() Supprime le tableau entier.
deleteColumns(columnIndex : number, columnCount ?: number) Supprime des colonnes spécifiques.
deleteRows(rowIndex : number, rowCount ?: number) Supprime des lignes spécifiques.
distributeColumns() Répartit uniformément les largeurs de colonne.
police Obtient la police.
getBorder(borderLocation : Word. BorderLocation) Obtient le style de la bordure spécifiée.
getCell(rowIndex: number, cellIndex: number) Obtient la cellule du tableau à une ligne et une colonne spécifiées.
getCellOrNullObject(rowIndex : number, cellIndex : number) Obtient la cellule du tableau à une ligne et une colonne spécifiées.
getCellPadding(cellPaddingLocation : Word. CellPaddingLocation) Obtient la marge intérieure des cellules en points.
getNext() Obtient le tableau suivant.
getNextOrNullObject() Obtient le tableau suivant.
getParagraphAfter() Obtient le paragraphe après le tableau.
getParagraphAfterOrNullObject() Obtient le paragraphe après le tableau.
getParagraphBefore() Obtient le paragraphe avant le tableau.
getParagraphBeforeOrNullObject() Obtient le paragraphe avant le tableau.
getRange(rangeLocation ?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | « Entier » | « Démarrer » | « End » | « After ») Obtient la plage qui contient ce tableau, ou la plage située au début ou à la fin du tableau.
headerRowCount Spécifie le nombre de lignes d’en-tête.
horizontalAlignment Spécifie l’alignement horizontal de chaque cellule du tableau.
insertContentControl() Insère un contrôle de contenu dans le tableau.
insertParagraph(paragraphText : string, insertLocation : Word. InsertLocation.before | Word. InsertLocation.after | « Avant » | « After ») Insère un paragraphe à l’emplacement spécifié.
insertTable(rowCount : number, columnCount : number, insertLocation : Word. InsertLocation.before | Word. InsertLocation.after | « Avant » | « After », values ?: string[][]) Insère un tableau avec le nombre spécifié de lignes et de colonnes.
isUniform Indique si toutes les lignes du tableau sont uniformes.
nestingLevel Obtient le niveau d’imbrication du tableau.
parentBody Obtient le corps parent du tableau.
parentContentControl Obtient le contrôle de contenu qui contient le tableau.
parentContentControlOrNullObject Obtient le contrôle de contenu qui contient le tableau.
parentTable Obtient le tableau qui contient ce tableau.
parentTableCell Obtient la cellule de tableau qui contient ce tableau.
parentTableCellOrNullObject Obtient la cellule de tableau qui contient ce tableau.
parentTableOrNullObject Obtient le tableau qui contient ce tableau.
rowCount Obtient le nombre de lignes dans le tableau.
rows Obtient toutes les lignes du tableau.
search(searchText : string, searchOptions ?: Word. SearchOptions | { ignorePunct ?: boolean ignoreSpace ?: boolean matchCase ?: boolean matchPrefix ?: boolean matchSuffix ?: boolean matchWholeWord ?: boolean matchWildcards ?: boolean }) Effectue une recherche avec l’objet SearchOptions spécifié dans l’étendue de l’objet table.
select(selectionMode ?: Word. SelectionMode) Sélectionne le tableau ou la position de début ou de fin du tableau et y accède dans l’interface utilisateur de Word.
setCellPadding(cellPaddingLocation : Word. CellPaddingLocation, cellPadding : number) Définit la marge intérieure des cellules en points.
shadingColor Spécifie la couleur d’ombrage.
style Spécifie le nom de style de la table.
styleBandedColumns Spécifie si la table comporte des colonnes à bandes.
styleBandedRows Spécifie si la table comporte des lignes à bandes.
styleBuiltIn Spécifie le nom de style intégré pour la table.
styleFirstColumn Spécifie si la table a une première colonne avec un style spécial.
styleLastColumn Spécifie si la table a une dernière colonne avec un style spécial.
styleTotalRow Spécifie si la table a un total (dernière) ligne avec un style spécial.
Tables Obtient les tableaux enfants imbriqués au niveau de profondeur suivant.
values Spécifie les valeurs de texte dans le tableau, sous la forme d’un tableau JavaScript 2D.
verticalAlignment Spécifie l’alignement vertical de chaque cellule du tableau.
width Spécifie la largeur du tableau en points.
TableBorder color Spécifie la couleur de bordure du tableau.
type Spécifie le type de bordure de la table.
width Spécifie la largeur, en points, de la bordure du tableau.
TableCell body Renvoie l’objet corps de la cellule.
cellIndex Obtient l’index de la cellule dans la ligne correspondante.
columnWidth Spécifie la largeur de la colonne de la cellule en points.
deleteColumn() Supprime la colonne qui contient cette cellule.
deleteRow() Supprime la ligne qui contient cette cellule.
getBorder(borderLocation : Word. BorderLocation) Obtient le style de la bordure spécifiée.
getCellPadding(cellPaddingLocation : Word. CellPaddingLocation) Obtient la marge intérieure des cellules en points.
getNext() Obtient la cellule suivante.
getNextOrNullObject() Obtient la cellule suivante.
horizontalAlignment Spécifie l’alignement horizontal de la cellule.
insertColumns(insertLocation : Word. InsertLocation.before | Word. InsertLocation.after | « Avant » | « After », columnCount : number, values ?: string[][]) Ajoute des colonnes à gauche ou à droite de la cellule, en utilisant la colonne de la cellule en tant que modèle.
insertRows(insertLocation : Word. InsertLocation.before | Word. InsertLocation.after | « Avant » | « After », rowCount : number, values ?: string[][]) Insère les lignes au-dessus ou au-dessous de la cellule, en utilisant la ligne de la cellule en tant que modèle.
parentRow Obtient la ligne parent de la cellule.
parentTable Obtient le tableau parent de la cellule.
rowIndex Obtient l’index de la ligne de la cellule dans le tableau.
setCellPadding(cellPaddingLocation : Word. CellPaddingLocation, cellPadding : number) Définit la marge intérieure des cellules en points.
shadingColor Spécifie la couleur d’ombrage de la cellule.
value Spécifie le texte de la cellule.
verticalAlignment Spécifie l’alignement vertical de la cellule.
width Obtient la largeur de la cellule en points.
TableCellCollection getFirst() Obtient la première cellule de tableau de cette collection.
getFirstOrNullObject() Obtient la première cellule de tableau de cette collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
TableCollection getFirst() Obtient le premier tableau de cette collection.
getFirstOrNullObject() Obtient le premier tableau de cette collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
TableRow cellCount Obtient le nombre de cellules dans la ligne.
Cellules Obtient les cellules.
clear() Efface le contenu de la ligne.
delete() Supprime la ligne entière.
police Obtient la police.
getBorder(borderLocation : Word. BorderLocation) Obtient le style de bordure des cellules de la ligne.
getCellPadding(cellPaddingLocation : Word. CellPaddingLocation) Obtient la marge intérieure des cellules en points.
getNext() Obtient la ligne suivante.
getNextOrNullObject() Obtient la ligne suivante.
horizontalAlignment Spécifie l’alignement horizontal de chaque cellule de la ligne.
insertRows(insertLocation : Word. InsertLocation.before | Word. InsertLocation.after | « Avant » | « After », rowCount : number, values ?: string[][]) Insère des lignes en utilisant cette ligne en tant que modèle.
isHeader Vérifie si la ligne est une ligne d’en-tête.
parentTable Obtient la table parente.
preferredHeight Spécifie la hauteur préférée de la ligne en points.
rowIndex Obtient l’index de la ligne dans le tableau parent correspondant.
search(searchText : string, searchOptions ?: Word. SearchOptions | { ignorePunct ?: boolean ignoreSpace ?: boolean matchCase ?: boolean matchPrefix ?: boolean matchSuffix ?: boolean matchWholeWord ?: boolean matchWildcards ?: boolean }) Effectue une recherche avec les SearchOptions spécifiées dans l’étendue de la ligne.
select(selectionMode ?: Word. SelectionMode) Sélectionne la ligne et y accède via l’interface utilisateur de Word.
setCellPadding(cellPaddingLocation : Word. CellPaddingLocation, cellPadding : number) Définit la marge intérieure des cellules en points.
shadingColor Spécifie la couleur d’ombrage.
values Spécifie les valeurs de texte dans la ligne, sous la forme d’un tableau JavaScript 2D.
verticalAlignment Spécifie l’alignement vertical des cellules de la ligne.
TableRowCollection getFirst() Obtient la première ligne de cette collection.
getFirstOrNullObject() Obtient la première ligne de cette collection.
items Obtient l’élément enfant chargé dans cette collection de sites.

Voir aussi