Nouveautés de Word’API JavaScript 1.4
WordApi 1.4 a ajouté la prise en charge des signets, du suivi des modifications, des commentaires, des parties XML personnalisées, des champs et de la fusion et du fractionnement des cellules de tableau.
Liste des API
Le tableau suivant répertorie les API dans Word’ensemble de conditions requises de l’API JavaScript 1.4. 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.4 ou antérieure, consultez Word API dans l’ensemble de conditions requises 1.4 ou version antérieure.
Classe | Champs | Description |
---|---|---|
Corps | fields | Obtient la collection d’objets de champ dans le corps. |
getComments() | Obtient les commentaires associés au corps. | |
getReviewedText(changeTrackingVersion?: Word. ChangeTrackingVersion) | Obtient le texte révisé en fonction de la sélection de ChangeTrackingVersion. | |
Commentaire | authorEmail | Obtenir l’adresse email de l’auteur du commentaire. |
authorName | Obtient le nom de l’auteur du commentaire. | |
content | Spécifie le contenu du commentaire sous forme de texte brut. | |
contentRange | Spécifie la plage de contenu du commentaire. | |
creationDate | Obtient la date de création du commentaire. | |
delete() | Supprime le commentaire et ses réponses. | |
getRange() | Obtient la plage dans le document main où se trouve le commentaire. | |
id | Obtient l’ID du commentaire. | |
Réponses | Obtient la collection d’objets de réponse associés au commentaire. | |
reply(replyText: string) | Ajoute une nouvelle réponse à la fin du fil de commentaire. | |
Résolu | Spécifie la status du thread de commentaire. | |
CommentCollection | getFirst() | Obtient le premier commentaire de la collection. |
getFirstOrNullObject() | Obtient le premier commentaire de la collection. | |
items | Obtient l’élément enfant chargé dans cette collection de sites. | |
CommentContentRange | bold | Spécifie une valeur qui indique si le texte du commentaire est en gras. |
lien hypertexte | Obtient le premier lien hypertexte de la plage ou définit un lien hypertexte sur la plage. | |
insertText(text: string, insertLocation: Word. InsertLocation | « Remplacer » | « Démarrer » | « End » | « Avant » | « After ») | Insère du texte dans à l’emplacement spécifié. | |
isEmpty | Vérifie si la longueur de la plage est zéro. | |
italic | Spécifie une valeur qui indique si le texte du commentaire est en italique. | |
Barré | Spécifie une valeur qui indique si le texte du commentaire a un barré. | |
text | Obtient le texte de la plage de commentaires. | |
underline | Spécifie une valeur qui indique le type de soulignement du texte du commentaire. | |
CommentReply | authorEmail | Obtenir l’adresse email de l’auteur de la réponse au commentaire. |
authorName | Obtenir le nom de l’auteur de la réponse au commentaire. | |
content | Spécifie le contenu de la réponse au commentaire. | |
contentRange | Spécifie la plage de contenu de commentReply. | |
creationDate | Obtient la date de création de la réponse au commentaire. | |
delete() | Supprime la réponse de commentaire. | |
id | Obtient l’ID de la réponse au commentaire. | |
parentComment | Obtient le commentaire parent de cette réponse. | |
CommentReplyCollection | getFirst() | Obtient la première réponse de commentaire dans la collection. |
getFirstOrNullObject() | Obtient la première réponse de commentaire dans la collection. | |
items | Obtient l’élément enfant chargé dans cette collection de sites. | |
ContentControl | fields | Obtient la collection d’objets de champ dans le contrôle de contenu. |
getComments() | Obtient les commentaires associés au contrôle de contenu. | |
getReviewedText(changeTrackingVersion?: Word. ChangeTrackingVersion) | Obtient le texte révisé en fonction de la sélection de ChangeTrackingVersion. | |
CustomXmlPart | delete() | Supprime la partie XML personnalisée. |
deleteAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string) | Supprime un attribut portant le nom donné de l’élément identifié par xpath. | |
deleteElement(xpath: string, namespaceMappings: { [key: string]: string }) | Supprime l’élément identifié par xpath. | |
getXml() | Obtient le contenu XML complet de la partie XML personnalisée. | |
id | Obtient l’ID de la partie XML personnalisée. | |
insertAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string) | Insère un attribut avec le nom et la valeur donnés à l’élément identifié par xpath. | |
insertElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string }, index?: number) | Insère le code XML donné sous l’élément parent identifié par xpath à l’index de position enfant. | |
Namespaceuri | Obtient l’URI de l’espace de noms de la partie XML personnalisée. | |
query(xpath: string, namespaceMappings: { [key: string]: string }) | Interroge le contenu XML de la partie XML personnalisée. | |
setXml(xml: string) | Définit le contenu XML complet de la partie XML personnalisée. | |
updateAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string) | Mises à jour la valeur d’un attribut avec le nom donné de l’élément identifié par xpath. | |
updateElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string }) | Mises à jour le code XML de l’élément identifié par xpath. | |
CustomXmlPartCollection | add(xml: string) | Ajoute un nouveau composant XML personnalisé au document. |
getByNamespace(namespaceUri: string) | Obtient une nouvelle collection limitée de parties XML personnalisées dont les espaces de noms correspondent à l’espace de noms donné. | |
getCount() | Obtient le nombre d'éléments dans la collection. | |
getItem(id: string) | Obtient une partie XML personnalisée en fonction de son ID. | |
getItemOrNullObject(id: string) | Obtient une partie XML personnalisée en fonction de son ID. | |
items | Obtient l’élément enfant chargé dans cette collection de sites. | |
CustomXmlPartScopedCollection | getCount() | Obtient le nombre d'éléments dans la collection. |
getItem(id: string) | Obtient une partie XML personnalisée en fonction de son ID. | |
getItemOrNullObject(id: string) | Obtient une partie XML personnalisée en fonction de son ID. | |
getOnlyItem() | Si la collection contient exactement un élément, cette méthode le renvoie. | |
getOnlyItemOrNullObject() | Si la collection contient exactement un élément, cette méthode le renvoie. | |
items | Obtient l’élément enfant chargé dans cette collection de sites. | |
Document | changeTrackingMode | Spécifie le mode ChangeTracking. |
customXmlParts | Obtient les parties XML personnalisées dans le document. | |
deleteBookmark(name: string) | Supprime un signet, s’il existe, du document. | |
getBookmarkRange(name: string) | Obtient la plage d’un signet. | |
getBookmarkRangeOrNullObject(name: string) | Obtient la plage d’un signet. | |
paramètres | Obtient les paramètres du complément dans le document. | |
Champ | code | Obtient l’instruction de code du champ. |
getNext() | Obtient le champ suivant. | |
getNextOrNullObject() | Obtient le champ suivant. | |
parentBody | Obtient le corps parent du champ. | |
parentContentControl | Obtient le contrôle de contenu qui contient le champ. | |
parentContentControlOrNullObject | Obtient le contrôle de contenu qui contient le champ. | |
parentTable | Obtient la table qui contient le champ. | |
parentTableCell | Obtient la cellule de tableau qui contient le champ. | |
parentTableCellOrNullObject | Obtient la cellule de tableau qui contient le champ. | |
parentTableOrNullObject | Obtient la table qui contient le champ. | |
result | Obtient les données de résultat du champ. | |
FieldCollection | getFirst() | Obtient le premier champ de cette collection. |
getFirstOrNullObject() | Obtient le premier champ de cette collection. | |
items | Obtient l’élément enfant chargé dans cette collection de sites. | |
Paragraph | fields | Obtient la collection de champs dans le paragraphe. |
getComments() | Obtient les commentaires associés au paragraphe. | |
getReviewedText(changeTrackingVersion?: Word. ChangeTrackingVersion) | Obtient le texte révisé en fonction de la sélection de ChangeTrackingVersion. | |
Range | fields | Obtient la collection d’objets de champ dans la plage. |
getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean) | Obtient les noms de tous les signets dans ou qui se chevauchent dans la plage. | |
getComments() | Obtient les commentaires associés à la plage. | |
getReviewedText(changeTrackingVersion?: Word. ChangeTrackingVersion) | Obtient le texte révisé en fonction de la sélection de ChangeTrackingVersion. | |
insertBookmark(name: string) | Insère un signet sur la plage. | |
insertComment(commentText: string) | Insérez un commentaire sur la plage. | |
Paramètre | delete() | Supprime le paramètre. |
key | Obtient la clé du paramètre. | |
value | Spécifie la valeur du paramètre. | |
SettingCollection | add(key: string, value: any) | Crée un paramètre ou définit un paramètre existant. |
deleteAll() | Supprime tous les paramètres de ce complément. | |
getCount() | Obtient le nombre de paramètres. | |
getItem(key: string) | Obtient un objet de paramètre par sa clé, qui respecte la casse. | |
getItemOrNullObject(key: string) | Obtient un objet de paramètre par sa clé, qui respecte la casse. | |
items | Obtient l’élément enfant chargé dans cette collection de sites. | |
Tableau | fields | Obtient la collection d’objets de champ dans la table. |
mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number) | Fusionne les cellules délimitées inclusivement par une première et une dernière cellule. | |
TableCell | split(rowCount: number, columnCount: number) | Fractionne la cellule en nombre spécifié de lignes et de colonnes. |
TableRow | fields | Obtient la collection d’objets de champ dans la ligne du tableau. |
merge() | Fusionne la ligne dans une cellule. |