Nouveautés de Word’API JavaScript 1.1

  • Article

WordApi 1.1 est le premier ensemble de conditions requises de l’API JavaScript Word. Il s’agit du seul ensemble de conditions requises d’API Word pris en charge par Word 2016.

Liste des API

Le tableau suivant répertorie les API dans Word’ensemble de conditions requises de l’API JavaScript 1.1. 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.1, consultez Word API dans l’ensemble de conditions requises 1.1.

Classe Champs Description
Corps clear() Efface le contenu de l’objet de corps.
contentControls Obtient la collection d’objets de contrôle de contenu de texte enrichi dans le corps.
police Obtient le format de texte du corps.
getHtml() Obtient une représentation HTML de l’objet body.
getOoxml() Obtient la représentation OOXML (Office Open XML) de l’objet de corps.
inlinePictures Obtient la collection d’objets InlinePicture dans le corps.
insertBreak(breakType: Word. BreakType | « Page » | « Suivant » | « SectionNext » | « SectionContinuous » | « SectionEven » | « SectionOdd » | « Line », insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | « Démarrer » | « Fin ») Insère un saut à l’emplacement spécifié du document principal.
insertContentControl() Encapsule l’objet Body avec un contrôle de contenu Texte enrichi.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère un document dans le corps à l’emplacement spécifié.
insertHtml(html: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère du code HTML à l’emplacement spécifié.
insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère du code OOXML à l’emplacement spécifié.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | « Démarrer » | « Fin ») Insère un paragraphe à l’emplacement spécifié.
insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère du texte dans le corps à l’emplacement spécifié.
paragraphs Obtient la collection d’objets de paragraphe dans le corps.
parentContentControl Obtient le contrôle de contenu qui contient le corps.
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 body.
select(selectionMode?: Word. SelectionMode) Sélectionne le corps et y accède via l’interface utilisateur de Word.
style Spécifie le nom du style pour le corps.
text Obtient le texte du corps.
ContentControl Apparence Spécifie l’apparence du contrôle de contenu.
cannotDelete Spécifie une valeur qui indique si l’utilisateur peut supprimer le contrôle de contenu.
impossibleModifier Spécifie une valeur qui indique si l’utilisateur peut modifier le contenu du contrôle de contenu.
clear() Efface le contenu du contrôle de contenu.
color Spécifie la couleur du contrôle de contenu.
contentControls Obtient la collection d’objets de contrôle de contenu compris dans le contrôle de contenu.
delete(keepContent: boolean) Supprime le contrôle de contenu et son contenu.
police Obtient le format de texte du contrôle de contenu.
getHtml() Obtient une représentation HTML de l’objet de contrôle de contenu.
getOoxml() Obtient la représentation Office Open XML (OOXML) de l’objet de contrôle de contenu.
id Obtient un entier qui représente l’identificateur du contrôle de contenu.
inlinePictures Obtient la collection d’objets InlinePicture dans le contrôle de contenu.
insertBreak(breakType: Word. BreakType | « Page » | « Suivant » | « SectionNext » | « SectionContinuous » | « SectionEven » | « SectionOdd » | « Line », insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | « Démarrer » | « End » | « Avant » | « After ») Insère un saut à l’emplacement spécifié du document principal.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère un document dans le contrôle de contenu à l’emplacement spécifié.
insertHtml(html: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère du code HTML dans le contrôle de contenu, à l’emplacement spécifié.
insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère OOXML dans le contrôle de contenu à l’emplacement spécifié.
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é.
insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère du texte dans le contrôle de contenu, à l’emplacement spécifié.
paragraphs Obtient la collection d’objets de paragraphe dans le contrôle de contenu.
parentContentControl Obtient le contrôle de contenu qui contient le contrôle de contenu spécifié.
placeholderText Spécifie le texte de l’espace réservé du contrôle de contenu.
removeWhenEdited Spécifie une valeur qui indique si le contrôle de contenu est supprimé après sa modification.
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és dans l’étendue de l’objet de contrôle de contenu.
select(selectionMode?: Word. SelectionMode) Sélectionne le contrôle de contenu.
style Spécifie le nom du style pour le contrôle de contenu.
tag Spécifie une balise pour identifier un contrôle de contenu.
text Obtient le texte du contrôle de contenu.
title Spécifie le titre d’un contrôle de contenu.
type Obtient le type du contrôle de contenu.
ContentControlCollection getById(id: number) Obtient un contrôle de contenu par son identificateur.
getByTag(tag: string) Obtient les contrôles de contenu qui portent l’indicateur spécifié.
getByTitle(title: string) Obtient les contrôles de contenu qui ont le titre spécifié.
getItem(id: number) Obtient un contrôle de contenu par son ID.
items Obtient l’élément enfant chargé dans cette collection de sites.
Document body Obtient l’objet body du document main.
contentControls Obtient la collection d’objets de contrôle de contenu dans le document.
getSelection() Obtient la sélection actuelle du document.
save() Enregistre le document.
Sauvé Indique si les modifications apportées au document ont été enregistrées.
sections Obtient la collection d’objets de section dans le document.
Font bold Spécifie une valeur qui indique si la police est en gras.
color Spécifie la couleur de la police spécifiée.
doubleStrikeThrough Spécifie une valeur qui indique si la police a un double barré.
highlightColor Spécifie la couleur de surbrillance.
italic Spécifie une valeur qui indique si la police est en italique.
name Spécifie une valeur qui représente le nom de la police.
size Spécifie une valeur qui représente la taille de police en points.
Barré Spécifie une valeur qui indique si la police a un barré.
Subscript Spécifie une valeur qui indique si la police est un indice.
superscript Spécifie une valeur qui indique si la police est un exposant.
underline Spécifie une valeur qui indique le type de soulignement de la police.
InlinePicture altTextDescription Spécifie une chaîne qui représente le texte de remplacement associé à l’image inline.
altTextTitle Spécifie une chaîne qui contient le titre de l’image incluse.
getBase64ImageSrc() Obtient la représentation sous forme de chaîne encodée en Base64 de l’image inline.
height Spécifie un nombre qui décrit la hauteur de l’image incluse.
lien hypertexte Spécifie un lien hypertexte sur l’image.
insertContentControl() Encadre l’image incluse avec un contrôle de contenu de texte enrichi.
lockAspectRatio Spécifie une valeur qui indique si l’image inline conserve ses proportions d’origine lorsque vous la redimensionnez.
parentContentControl Obtient le contrôle de contenu qui contient l’image incluse.
width Spécifie un nombre qui décrit la largeur de l’image inline.
InlinePictureCollection items Obtient l’élément enfant chargé dans cette collection de sites.
Paragraph Alignement Spécifie l’alignement d’un paragraphe.
clear() Efface le contenu de l’objet de paragraphe.
contentControls Obtient la collection d’objets de contrôle de contenu dans le paragraphe.
delete() Supprime le paragraphe et son contenu du document.
firstLineIndent Spécifie la valeur, en points, d’une première ligne ou d’un retrait négatif.
police Obtient le format de texte du paragraphe.
getHtml() Obtient une représentation HTML de l’objet paragraphe.
getOoxml() Obtient la représentation Office Open XML (OOXML) de l’objet de paragraphe.
inlinePictures Obtient la collection d’objets InlinePicture dans le paragraphe.
insertBreak(breakType: Word. BreakType | « Page » | « Suivant » | « SectionNext » | « SectionContinuous » | « SectionEven » | « SectionOdd » | « Line », insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | « Avant » | « After ») Insère un saut à l’emplacement spécifié du document principal.
insertContentControl() Encapsule l’objet Paragraph avec un contrôle de contenu de texte enrichi.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère un document dans le paragraphe à l’emplacement spécifié.
insertHtml(html: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère du code HTML dans le paragraphe à l’emplacement spécifié.
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère une image dans le paragraphe à l’emplacement spécifié.
insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère OOXML dans le paragraphe à l’emplacement spécifié.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | « Avant » | « After ») Insère un paragraphe à l’emplacement spécifié.
insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | « Remplacer » | « Démarrer » | « Fin ») Insère du texte dans le paragraphe à l’emplacement spécifié.
leftIndent Spécifie la valeur de retrait gauche, en points, pour le paragraphe.
Linespacing Spécifie l’espacement des lignes, en points, pour le paragraphe spécifié.
lineUnitAfter Spécifie la quantité d’espacement, en lignes de grille, après le paragraphe.
lineUnitBefore Spécifie la quantité d’espacement, dans les lignes de grille, avant le paragraphe.
outlineLevel Spécifie le niveau hiérarchique du paragraphe.
parentContentControl Obtient le contrôle de contenu qui contient le paragraphe.
rightIndent Spécifie la valeur de retrait à droite, en points, pour le paragraphe.
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 paragraphe.
select(selectionMode?: Word. SelectionMode) Sélectionne le paragraphe et y accède via l’interface utilisateur de Word.
Spaceafter Spécifie l’espacement, en points, après le paragraphe.
spaceBefore Spécifie l’espacement, en points, avant le paragraphe.
style Spécifie le nom du style pour le paragraphe.
text Obtient le texte du paragraphe.
ParagraphCollection items Obtient l’élément enfant chargé dans cette collection de sites.
Range clear() Efface le contenu de l’objet de plage.
contentControls Obtient la collection d’objets de contrôle de contenu dans la plage.
delete() Supprime la plage et son contenu du document.
police Obtient le format de texte de la plage.
getHtml() Obtient une représentation HTML de l’objet de plage.
getOoxml() Obtient la représentation OOXML de l’objet de plage.
insertBreak(breakType: Word. BreakType | « Page » | « Suivant » | « SectionNext » | « SectionContinuous » | « SectionEven » | « SectionOdd » | « Line », insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | « Avant » | « After ») Insère un saut à l’emplacement spécifié du document principal.
insertContentControl() Encapsule l’objet Range avec un contrôle de contenu de texte enrichi.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation | « Remplacer » | « Démarrer » | « End » | « Avant » | « After ») Insère un document à l’emplacement spécifié.
insertHtml(html: string, insertLocation: Word. InsertLocation | « Remplacer » | « Démarrer » | « End » | « Avant » | « After ») Insère du code HTML à l’emplacement spécifié.
insertOoxml(ooxml: string, insertLocation: Word. InsertLocation | « Remplacer » | « Démarrer » | « End » | « Avant » | « After ») Insère du code OOXML à l’emplacement spécifié.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | « Avant » | « After ») Insère un paragraphe à l’emplacement spécifié.
insertText(text: string, insertLocation: Word. InsertLocation | « Remplacer » | « Démarrer » | « End » | « Avant » | « After ») Insère du texte à l’emplacement spécifié.
paragraphs Obtient la collection d’objets de paragraphe dans la plage.
parentContentControl Obtient le contrôle de contenu qui contient la plage.
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és sur l’étendue de l’objet de plage.
select(selectionMode?: Word. SelectionMode) Sélectionne la plage et y accède via l’interface utilisateur de Word.
style Spécifie le nom de style de la plage.
text Obtient le texte de la plage.
RangeCollection items Obtient l’élément enfant chargé dans cette collection de sites.
SearchOptions ignorePunct Spécifie une valeur qui indique s’il faut ignorer tous les caractères de ponctuation entre les mots.
ignoreSpace Spécifie une valeur qui indique s’il faut ignorer tous les espaces blancs entre les mots.
matchCase Spécifie une valeur qui indique s’il faut effectuer une recherche respectant la casse.
matchPrefix Spécifie une valeur qui indique s’il faut faire correspondre des mots commençant par la chaîne de recherche.
matchSuffix Spécifie une valeur qui indique s’il faut faire correspondre les mots qui se terminent par la chaîne de recherche.
matchWholeWord Spécifie une valeur qui indique s’il faut rechercher uniquement des mots entiers, et non du texte qui fait partie d’un mot plus grand.
matchWildcards Spécifie une valeur qui indique si la recherche sera effectuée à l’aide d’opérateurs de recherche spéciaux.
Section body Obtient l’objet body de la section.
getFooter(type : Word. HeaderFooterType) Obtient l’un des pieds de page de la section.
getHeader(type : Word. HeaderFooterType) Obtient l’un des en-têtes de la section.
SectionCollection items Obtient l’élément enfant chargé dans cette collection de sites.

Voir aussi