Partager via

Word ensemble de conditions requises de l’API JavaScript pour bureau uniquement 1.2

  • Article

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

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

Importante

WordApiDesktop 1.2 est un ensemble de conditions requises pour le 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 sont uniquement prises en charge par Word sur Windows, sur Mac et sur iPad, votre complément doit case activée si l’ensemble de conditions requises est pris en charge avant d’appeler ces API. Cela évite toute tentative d’utilisation d’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 est dans un ensemble de conditions requises multiplateforme, vous devez supprimer ou modifier le isSetSupported case activée. Cela permet d’activer la fonctionnalité de votre complément sur d’autres plateformes. Veillez à tester la fonctionnalité sur ces plateformes lors de cette modification.

Importante

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

Liste des API

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

Classe Champs Description
Body Formes Obtient la collection d’objets de forme dans le corps, y compris les formes insérées et flottantes.
Canvas id Obtient un entier qui représente l’identificateur de canevas.
shape Obtient l’objet Shape associé au canevas.
Formes Obtient la collection d’objets Shape.
Document activeWindow Obtient 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.
Windows Obtient la collection d’objets Word.Window pour le document.
InsertShapeOptions height Représente la hauteur de la forme insérée.
left Représente la position gauche de la forme insérée.
top Représente la position supérieure de la forme insérée.
width Représente la largeur de la forme insérée.
Page getNext() Obtient la page suivante dans le volet.
getNextOrNullObject() Obtient la page suivante.
getRange(rangeLocation ?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | « Entier » | « Démarrer » | « Fin ») Obtient la page entière, ou le point de départ ou de fin de la page, sous forme de 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() Obtient le volet suivant dans la fenêtre.
getNextOrNullObject() Obtient le volet suivant.
pages Obtient la collection de pages dans le volet.
pagesEnclosingViewport Obtient le PageCollection affiché dans la fenêtre d’affichage du volet.
PaneCollection getFirst() Obtient le premier volet de cette collection.
getFirstOrNullObject() Obtient 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 un canevas flottant devant le texte avec son ancre au début du paragraphe.
insertGeometricShape(geometricShapeType : Word. GeometricShapeType, insertShapeOptions ?: Word. InsertShapeOptions) Insère une forme géométrique devant le texte avec son ancre au début du paragraphe.
insertPictureFromBase64(base64EncodedImage : string, insertShapeOptions ?: Word. InsertShapeOptions) Insère une image flottante devant le texte avec son ancre au début du paragraphe.
insertTextBox(text ?: string, insertShapeOptions ?: Word. InsertShapeOptions) Insère une zone de texte flottante devant le texte avec son ancre au début du paragraphe.
Formes Obtient la collection d’objets de forme ancrés dans le paragraphe, y compris les formes insérées et flottantes.
Range insertCanvas(insertShapeOptions ?: Word. InsertShapeOptions) Insère un canevas flottant devant le texte avec son ancre 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 ancre au début de la plage.
insertPictureFromBase64(base64EncodedImage : string, insertShapeOptions ?: Word. InsertShapeOptions) Insère une image flottante devant le texte avec son ancre au début de la plage.
insertTextBox(text ?: string, insertShapeOptions ?: Word. InsertShapeOptions) Insère une zone de texte flottante devant le texte avec son ancre au début de la plage.
pages Obtient la collection de pages de la plage.
Formes Obtient la collection d’objets de forme ancrés dans la plage, y compris les formes insérées et flottantes.
Forme allowOverlap Spécifie si une forme donnée peut chevaucher d’autres formes.
altTextDescription Spécifie une chaîne qui représente le texte de remplacement associé à la forme.
body Représente l’objet body de la forme.
toile Obtient le canevas associé à la forme.
delete() Supprime la forme et son contenu.
fill Renvoie la mise en forme de remplissage de la forme.
geometricShapeType Type de forme géométrique de la forme.
height Hauteur, en points, de la forme.
heightRelative Pourcentage de hauteur de forme par taille relative verticale, voir Word. RelativeSize.
id Obtient un entier qui représente l’identificateur de forme.
isChild Vérifiez si cette forme est un enfant d’une forme de groupe ou d’une forme de canevas.
left La distance, en points, entre le côté gauche de la forme et la position relative horizontale, voir Word. RelativeHorizontalPosition.
leftRelative La position relative à gauche sous la forme d’un pourcentage entre le côté gauche de la forme et la position relative horizontale, voir Word. RelativeHorizontalPosition.
lockAspectRatio Spécifie si les proportions de cette forme sont verrouillées.
moveHorizontally(distance : number) Déplace la forme horizontalement selon le nombre de points.
moveVertical(distance : number) Déplace la forme verticalement en fonction du nombre de points.
name Nom de la forme.
parentCanvas 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 Position horizontale relative de la forme.
relativeHorizontalSize Taille horizontale relative de la forme.
relativeVerticalPosition Position verticale relative de la forme.
relativeVerticalSize 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 ?: boolean) Sélectionne la forme.
shapeGroup Obtient le groupe de formes associé à la forme.
textFrame Obtient l’objet de cadre de texte de la forme.
textWrap Retourne la mise en forme de habillage du texte de la forme.
top La distance, en points, entre le bord supérieur de la forme et la position relative verticale, voir Word. RelativeVerticalPosition.
topRelative La position supérieure relative sous la forme d’un pourcentage entre le bord supérieur de la forme et la position relative verticale, voir Word. RelativeVerticalPosition.
type Obtient le type de forme.
visible Spécifie si la forme est visible.
width Largeur, en points, de la forme.
widthRelative Pourcentage de largeur de forme par taille relative horizontale, voir Word. RelativeSize.
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 identificateur.
getByIdOrNullObject(id : number) Obtient une forme par son identificateur.
getByIds(ids : number[]) Obtient les formes en fonction des 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.
group() Groupes de formes flottantes dans cette collection, les formes inline 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 de 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 sans 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 sans 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 sans texte entourant la forme spécifiée.
côté Spécifie si le texte du document doit être encapsulé des deux côtés de la forme spécifiée, à gauche ou à droite uniquement, ou sur le côté le plus éloigné de la marge de la page.
topDistance Spécifie 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 du texte autour de la forme.
TextFrame autoSizeSetting Paramètres de dimensionnement automatique pour le cadre de texte.
bottomMargin Représente la marge bas, en points du cadre du texte.
hasText Spécifie si le cadre de texte contient du texte.
leftMargin Représente la marge gauche, en points du cadre du texte.
noTextRotation Renvoie la valeur True si le texte du cadre de texte ne doit pas pivoter lorsque la forme est pivotée.
Orientation Représente l’angle vers lequel le texte est orienté pour le cadre de texte.
rightMargin Représente la marge droite, en points du cadre du texte.
topMargin Représente la marge du haut, en points du cadre du texte.
verticalAlignment Représente l’alignement vertical pour le style.
wordWrap Détermine si les lignes se cassent automatiquement pour insérer du texte à l’intérieur de la forme.
Window activePane Obtient le volet actif dans la fenêtre.
Vitres Obtient la collection de volets dans la fenêtre.
WindowCollection getFirst() Obtient la première fenêtre de cette collection.
getFirstOrNullObject() Obtient la première fenêtre de cette collection.
items Obtient l’élément enfant chargé dans cette collection de sites.

Voir aussi