Word JavaScript API Ensemble de conditions requises pour bureau uniquement 1.2

L’ensemble WordApiDesktop de conditions requises est un ensemble de conditions requises spécial qui inclut des fonctionnalités disponibles uniquement pour Word sur Windows, Mac et iPad. Les API de cet ensemble de conditions requises sont considérées comme des API de production pour l’application Word sur Windows, Mac et iPad. Ils suivent les stratégies de support des développeurs Microsoft 365. WordApiDesktop Les API sont considérées comme des API de « préversion » pour d’autres plateformes (web) et peuvent ne pas être prises en charge par ces plateformes.

Lorsque les API de l’ensemble WordApiDesktop d’exigences sont prises en charge sur toutes les plateformes, elles sont ajoutées à l’ensemble d’exigences publié suivant (WordApi 1.[NEXT]). Une fois ce nouvel ensemble de conditions requises public, ces API continueront également à être étiquetées dans cet WordApiDesktop ensemble de conditions. Pour en savoir plus sur les exigences spécifiques à la plateforme en général, consultez Présentation des ensembles d’exigences spécifiques à la plateforme.

Importante

WordApiDesktop 1.2 est un ensemble de conditions requises pour ordinateur de bureau uniquement. Il s’agit d’un sur-ensemble de WordApi 1.9 et WordApiDesktop 1.1.

Étant donné que les WordApiDesktop 1.2 API ne sont prises en charge que par Word sur Windows, Mac et iPad, votre complément doit case activée si l’ensemble requis est pris en charge avant d’appeler ces API. Cela évite toute tentative d’utilisation des API de bureau uniquement sur une plateforme non prise en charge.

if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.2")) {
   // Any API exclusive to this WordApiDesktop requirement set.
}

Une fois que l’API se trouve dans un ensemble de conditions requises multiplateforme, vous devez supprimer ou modifier la isSetSupported case activée. Cela activera la fonctionnalité de votre complément sur d’autres plateformes. Veillez à tester la fonctionnalité sur ces plateformes lorsque vous effectuez cette modification.

Importante

Votre manifeste ne peut pas spécifier WordApiDesktop 1.2 comme condition d’activation. Ce n’est pas une valeur valide à utiliser dans l’élément Set.

Liste des API

Le tableau suivant répertorie les API JavaScript de Word actuellement incluses dans le jeu de WordApiDesktop 1.2 conditions. Pour obtenir la liste complète de toutes les API JavaScript de Word (y compris WordApiDesktop 1.2 les API et les API publiées précédemment), voir toutes les API JavaScript de Word.

Classe Champs Description
Body Formes Obtient la collection d’objets Shape dans le corps, y compris les formes incorporées et flottantes.
Canvas id Obtient un entier qui représente l’identificateur de zone de dessin.
shape Obtient l’objet Shape associé au canevas.
Formes Obtient la collection de Word. Objets de forme.
Document activeWindow Récupère la fenêtre active du document.
compareFromBase64(base64File : string, documentCompareOptions ?: Word. DocumentCompareOptions) Affiche des marques de révision qui indiquent en quoi le document spécifié diffère d'un autre document.
fenêtres Obtient la collection d’objets Word.Window pour le document.
Font hidden Indique si la police est marquée comme masquée.
Options InsertShapeOptions height Le cas échéant, spécifie la hauteur de la forme insérée.
left Le cas échéant, spécifie la position à gauche de la forme insérée.
top Le cas échéant, spécifie la position supérieure de la forme insérée.
width Si elle est fournie, spécifie la largeur de la forme insérée.
Page getNext() Atteint la page suivante dans le volet.
getNextOrNullObject() Ouvre la page suivante.
getRange(rangeLocation ?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | « Entier » | « Démarrer » | « Fin ») Récupère la page entière, ou le point de début ou de fin de la page, sous la forme d’une plage.
height Obtient la hauteur, en points, du papier défini dans la boîte de dialogue Mise en page.
index Obtient l’index de la page.
width Obtient la largeur, en points, du papier défini dans la boîte de dialogue Mise en page.
PageCollection getFirst() Obtient la première page de cette collection.
getFirstOrNullObject() Obtient la première page de cette collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
Pane getNext() Ouvre le volet suivant dans la fenêtre.
getNextOrNullObject() Obtient le volet suivant.
pages Obtient l’ensemble des pages du volet.
pagesEnclosingViewport Récupère les PageCollection affichés dans la fenêtre d’affichage du volet.
PaneCollection getFirst() Ouvre le premier volet de cette collection.
getFirstOrNullObject() Ouvre le premier volet de cette collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
Paragraph insertCanvas(insertShapeOptions ?: Word. InsertShapeOptions) Insère une zone de dessin flottante devant le texte avec son ancrage au début du paragraphe.
insertGeometricShape(geometricShapeType : Word. GeometricShapeType, insertShapeOptions ?: Word. InsertShapeOptions) Insère une forme géométrique devant le texte avec son ancrage au début du paragraphe.
insertPictureFromBase64(base64EncodedImage : string, insertShapeOptions ?: Word. InsertShapeOptions) Insère une image flottante devant le texte avec son ancrage au début du paragraphe.
insertTextBox(text ?: string, insertShapeOptions ?: Word. InsertShapeOptions) Insère une zone de texte flottante devant le texte avec son ancrage au début du paragraphe.
Formes Obtient la collection d’objets Shape ancrés dans le paragraphe, y compris les formes incorporées et flottantes.
Range insertCanvas(insertShapeOptions ?: Word. InsertShapeOptions) Insère une zone de dessin flottante devant le texte avec son ancrage au début de la plage.
insertGeometricShape(geometricShapeType : Word. GeometricShapeType, insertShapeOptions ?: Word. InsertShapeOptions) Insère une forme géométrique devant le texte avec son ancrage au début de la plage.
insertPictureFromBase64(base64EncodedImage : string, insertShapeOptions ?: Word. InsertShapeOptions) Insère une image flottante devant le texte avec son ancrage au début de la plage.
insertTextBox(text ?: string, insertShapeOptions ?: Word. InsertShapeOptions) Insère une zone de texte flottante devant le texte avec son ancrage au début de la plage.
pages Obtient la collection de pages de la plage.
Formes Obtient la collection d’objets Shape ancrés dans la plage, y compris les formes incorporées et flottantes.
Forme allowOverlap Indique si une forme donnée peut chevaucher d’autres formes.
altTextDescription Spécifie une chaîne représentant le texte de remplacement associé à la forme.
body Récupère l’objet Body de la forme.
zone de dessin Récupère la zone de dessin associée à la forme.
delete() Supprime la forme et son contenu.
fill Renvoie la mise en forme de remplissage de la forme.
geometricShapeType Spécifie le type de forme géométrique de la forme.
height Spécifie la hauteur, en points, de la forme.
heightRelative Spécifie le pourcentage de la hauteur de la forme par rapport à la taille verticale relative (c’est-à-dire la relativeVerticalSize propriété).
id Obtient un nombre entier qui représente l’identificateur de forme.
isChild Vérifiez si cette forme est l’enfant d’une forme de groupe ou d’une forme de canevas.
left Spécifie la distance, en points, entre le côté gauche de la forme et la position horizontale relative (c’est-à-dire la relativeHorizontalPosition propriété).
leftRelative Spécifie la position relative à gauche sous forme de pourcentage, entre le côté gauche de la forme et la position horizontale relative (c’est-à-dire la relativeHorizontalalPosition propriété).
lockAspectRatio Indique si les proportions de cette forme sont verrouillées.
moveHorizontally(distance : number) Déplace la forme horizontalement en fonction du nombre de points.
moveVertically(distance : number) Déplace la forme verticalement en fonction du nombre de points.
name Spécifie le nom de la forme.
canevas parental Obtient la forme de canevas parent de niveau supérieur de cette forme enfant.
parentGroup Obtient la forme de groupe parent de niveau supérieur de cette forme enfant.
relativeHorizontalPosition Spécifie la position horizontale relative de la forme.
relativeHorizontalSize Spécifie la taille horizontale relative de la forme.
relativeVerticalPosition Spécifie la position verticale relative de la forme.
relativeVerticalSize Spécifie la taille verticale relative de la forme.
rotation Spécifie la rotation, en degrés, de la forme.
scaleHeight(scaleFactor : number, scaleType : Word. ShapeScaleType, scaleFrom ?: Word. ShapeScaleFrom) Met la hauteur de la forme à l’échelle en utilisant un facteur spécifié.
scaleWidth(scaleFactor : number, scaleType : Word. ShapeScaleType, scaleFrom ?: Word. ShapeScaleFrom) Met la largeur de la forme à l’échelle en utilisant un facteur spécifié.
select(selectMultipleShapes ?: booléen) Sélectionne la forme.
shapeGroup Récupère le groupe de formes associé à la forme.
textFrame Récupère l’objet TextFrame de la forme.
textWrap Renvoie la mise en forme d’habillage du texte de la forme.
top Spécifie la distance, en points, entre le bord supérieur de la forme et la position verticale relative (c’est-à-dire la relativeVerticalPosition propriété).
topRelative Spécifie la position supérieure relative sous forme de pourcentage, du bord supérieur de la forme à la position verticale relative (c’est-à-dire la relativeVerticalPosition propriété).
type Récupère le type de forme.
visible Indique si la forme est visible.
width Spécifie la largeur, en points, de la forme.
widthRelative Spécifie le pourcentage de largeur de la forme par rapport à la taille horizontale relative (c’est-à-dire la relativeHorizontalSize propriété).
ShapeCollection getByGeometricTypes(types : Word. GeometricShapeType[]) Obtient les formes qui ont les types géométriques spécifiés.
getById(id: number) obtient une forme par son identifiant.
getByIdOrNullObject(id : number) obtient une forme par son identifiant.
getByIds(ids : number[]) Obtient les formes par les identificateurs.
getByNames(names : string[]) Obtient les formes qui ont les noms spécifiés.
getByTypes(types : Word. ShapeType[]) Obtient les formes qui ont les types spécifiés.
getFirst() Obtient la première forme de cette collection.
getFirstOrNullObject() Obtient la première forme de cette collection.
groupe() Groupes de formes flottantes dans cette collection, les formes en ligne seront ignorées.
items Obtient l’élément enfant chargé dans cette collection de sites.
ShapeFill backgroundColor Spécifie la couleur d’arrière-plan du remplissage de la forme.
clear() Efface la mise en forme de remplissage de cette forme et la définit sur Word.ShapeFillType.noFill.
foregroundColor Spécifie la couleur de premier plan du remplissage de la forme.
setSolidColor(color: string) Définit le format de remplissage d’un élément de graphique sur une couleur unie.
Transparency Spécifie le pourcentage de transparence du remplissage sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (clair).
type Renvoie le type de remplissage de la forme.
ShapeGroup id Obtient un entier qui représente l’identificateur du groupe de formes.
shape Obtient l’objet Shape associé au groupe.
Formes Obtient la collection d’objets Shape .
ungroup() Dissocie toutes les formes groupées dans la forme spécifiée.
ShapeTextWrap bottomDistance Spécifie la distance (en points) entre le texte du document et le bord inférieur de la zone libre de texte entourant la forme spécifiée.
leftDistance Spécifie la distance (en points) entre le texte du document et le bord gauche de la zone libre de texte entourant la forme spécifiée.
rightDistance Spécifie la distance (en points) entre le texte du document et le bord droit de la zone libre de texte entourant la forme spécifiée.
côté Indique si le texte du document doit être renvoyé à la ligne des deux côtés de la forme spécifiée, à gauche ou à droite uniquement, ou sur le côté de la forme le plus éloigné de la marge de la page.
topDistance Indique la distance (en points) entre le texte du document et le bord supérieur de la zone sans texte entourant la forme spécifiée.
type Spécifie le type d’habillage de texte autour de la forme.
TextFrame autoSizeSetting Spécifie les paramètres de dimensionnement automatique du bloc de texte.
bottomMargin Spécifie la marge inférieure, en points, du bloc de texte.
hasText Renvoie true si le bloc de texte contient du texte, sinon, false.
leftMargin Spécifie la marge gauche, en points, du bloc de texte.
noTextRotation Indique si le texte du bloc de texte ne doit pas pivoter lors de la rotation de la forme.
Orientation Spécifie l’angle d’orientation du texte pour le bloc de texte.
rightMargin Spécifie la marge droite, en points, du bloc de texte.
topMargin Spécifie la marge supérieure, en points, du bloc de texte.
verticalAlignment Spécifie l’alignement vertical du bloc de texte.
wordWrap Détermine si les lignes s’ajustent automatiquement pour ajuster le texte à l’intérieur de la forme.
Window activePane Obtient le volet actif dans la fenêtre.
volets Obtient l’ensemble des volets de la fenêtre.
Collection de fenêtres getFirst() Ouvre la première fenêtre de cette collection.
getFirstOrNullObject() Ouvre la première fenêtre de cette collection.
items Obtient l’élément enfant chargé dans cette collection de sites.

Voir aussi

  • Last updated on