Partager via

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

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

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

Classe Champs Description
Border color Spécifie la couleur de la bordure.
location Obtient l’emplacement de la bordure.
type Spécifie le type de bordure pour la bordure.
visible Spécifie 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 » | « Left » | « Bottom » | « Right » | « 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) Obtient 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) Importer 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 fichiers récemment 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 S’il est fourni, spécifie le document cible pour la comparaison.
detectFormatChanges Si elle est fournie, spécifie si la comparaison doit inclure la détection des modifications de format.
ignoreAllComparisonWarnings S’il est fourni, spécifie s’il faut comparer les documents sans avertir un utilisateur de problèmes.
removeDateAndTime S’il est fourni, spécifie s’il faut supprimer les informations de date et d’heure des modifications suivies dans l’objet retourné Document .
removePersonalInformation S’il est fourni, spécifie s’il faut supprimer toutes les informations utilisateur des commentaires, des révisions et de la boîte de dialogue des propriétés dans l’objet retourné Document .
Field showCodes Spécifie si les codes de champ sont affichés pour le champ spécifié.
InlinePicture imageFormat Obtient le format de l’image incluse.
List getLevelFont(level : number) Obtient la police de la puce, du nombre ou de l’image au niveau spécifié dans la liste.
getLevelPicture(level : number) Obtient la représentation sous forme de chaîne encodé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 alignement Spécifie l’alignement horizontal du niveau de liste.
police Obtient un Font objet qui représente la mise en forme des caractères de l’objet ListLevel .
linkedStyle Spécifie le nom du style lié à l’objet ListLevel .
numberFormat Spécifie le format numérique 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 numérique de l’objet ListLevel .
resetOnHigher Spécifie le niveau de liste qui doit apparaître avant de redémarrer la numérotation à 1.
startAt Spécifie le numéro de départ de l’objet ListLevel .
tabPosition Spécifie la position de tabulation de l’objet ListLevel .
textPosition Spécifie la position (en points) de la deuxième ligne du texte d’habillage de l’objet ListLevel .
trailingCharacter Spécifie le caractère inséré après le numéro du 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 Spécifie si le modèle de liste est numéroté.
Shading foregroundPatternColor Spécifie la couleur du premier plan de l’objet.
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.
listTemplate 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 de la table par rapport à la marge de page.
allowBreakAcrossPage Spécifie si les lignes des tableaux sont mises en forme avec un saut de style entre les pages.

Voir aussi

  • Last updated on