Word JavaScript API Bureau uniquement jeu de conditions requises 1.1

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.1 est un ensemble de conditions requises pour ordinateur de bureau uniquement. Il s’agit d’un sur-ensemble de WordApi 1.8.

Étant donné que les WordApiDesktop 1.1 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.1")) {
   // 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.1 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.1 conditions. Pour obtenir la liste complète de toutes les API JavaScript de Word (y compris WordApiDesktop 1.1 les API et les API publiées précédemment), voir toutes les API JavaScript de Word.

Classe Champs Description
Border color Spécifie la couleur de la bordure.
location Récupère l’emplacement de la bordure.
type Spécifie le type de bordure de la bordure.
visible Indique si la bordure est visible.
width Spécifie la largeur de la bordure.
BorderCollection getByLocation(borderLocation : Word.BorderLocation.top | Word. BorderLocation.left | Word. BorderLocation.bottom | Word. BorderLocation.right | Word. BorderLocation.insideHorizontal | Word. BorderLocation.insideVertical | « Top » | « Gauche » | « En bas » | « Droite » | « InsideHorizontal » | « InsideVertical ») Obtient la bordure qui a l’emplacement spécifié.
getFirst() Obtient la première bordure de cette collection.
getFirstOrNullObject() Obtient la première bordure de cette collection.
getItem(index : numérique) Récupère un Border objet par son index dans la collection.
insideBorderColor Spécifie la couleur 24 bits des bordures intérieures.
insideBorderType Spécifie le type de bordure des bordures intérieures.
insideBorderWidth Spécifie la largeur des bordures intérieures.
items Obtient l’élément enfant chargé dans cette collection de sites.
outsideBorderColor Spécifie la couleur 24 bits des bordures extérieures.
outsideBorderType Spécifie le type de bordure des bordures extérieures.
outsideBorderWidth Spécifie la largeur des bordures extérieures.
Document compare(filePath : string, documentCompareOptions ?: Word. DocumentCompareOptions) Affiche des marques de révision qui indiquent en quoi le document spécifié diffère d'un autre document.
importStylesFromJson(stylesJson : string, importedStylesConflictBehavior ?: Word. ImportedStylesConflictBehavior) Importez des styles à partir d’une chaîne au format JSON.
DocumentCompareOptions addToRecentFiles S’il est fourni, spécifie s’il faut ajouter le document à la liste des derniers fichiers utilisés dans le menu Fichier .
authorName S’il est fourni, spécifie le nom du réviseur associé aux différences générées par la comparaison.
compareTarget Le cas échéant, spécifie le document cible pour la comparaison.
detectFormatChanges Le cas échéant, indique si la comparaison doit inclure la détection des modifications de format.
ignoreAllComparisonWarnings Le cas échéant, indique s’il faut comparer les documents sans avertir l’utilisateur des problèmes.
removeDateAndTime Le cas échéant, indique s’il faut supprimer les informations de date et d’heure des modifications suivies dans l’objet renvoyé Document .
removePersonalInformation Le cas échéant, indique si toutes les informations utilisateur doivent être supprimées des commentaires, des révisions et de la boîte de dialogue des propriétés dans l’objet renvoyé Document .
Field showCodes Indique si les codes de champ sont affichés pour le champ spécifié.
InlinePicture Format d’image Obtient le format de l’image incluse.
List getLevelFont(level : number) Obtient la police de la puce, du numéro ou de l’image au niveau spécifié dans la liste.
getLevelPicture(level : number) Obtient la représentation de chaîne codée en Base64 de l’image au niveau spécifié dans la liste.
resetLevelFont(level : number, resetFontName ?: boolean) Réinitialise la police de la puce, du numéro ou de l’image au niveau spécifié dans la liste.
setLevelPicture(level : number, base64EncodedImage ?: string) Définit l’image au niveau spécifié dans la liste.
ListLevel (Niveau de liste) alignement Spécifie l’alignement horizontal du niveau de la liste.
police Obtient un Font objet qui représente la mise en forme de caractère de l’objet ListLevel .
linkedStyle Spécifie le nom du style lié à l’objet ListLevel .
numberFormat Spécifie le format de nombre pour le niveau de liste.
numberPosition Spécifie la position (en points) du numéro ou de la puce de l’objet ListLevel .
numberStyle Spécifie le style de nombre de l’objet ListLevel .
resetOnHigher Spécifie le niveau de liste qui doit apparaître avant qu’il ne redémarre la numérotation à 1.
startAt Spécifie le numéro de départ de l’objet ListLevel .
tabPosition Spécifie la position de la tabulation pour l’objet ListLevel .
textPosition Indique la position (en points) de la deuxième ligne d’habillage du texte de l’objet ListLevel .
trailingCharacter Spécifie le caractère inséré après le numéro pour le niveau de liste.
ListLevelCollection getFirst() Obtient le premier niveau de liste de cette collection.
getFirstOrNullObject() Obtient le premier niveau de liste de cette collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
ListTemplate listLevels Obtient un ListLevelCollection objet qui représente tous les niveaux du modèle de liste.
outlineNumbered Indique si le modèle de liste est numéroté par le plan.
Shading foregroundPatternColor Spécifie la couleur du premier plan de l’objet.
de texture Spécifie la texture d’ombrage de l’objet.
Style Borders Spécifie un BorderCollection objet qui représente toutes les bordures du style.
Modèle de liste Obtient un ListTemplate objet qui représente la mise en forme de liste pour le style.
TableRow insertContentControl() Insère un contrôle de contenu sur la ligne.
TableStyle alignement Spécifie l’alignement du tableau par rapport à la marge de la page.
allowBreakAcrossPage Indique si les lignes des tableaux mis en forme avec un style sautent sur les pages.

Voir aussi

  • Last updated on