Ensemble de conditions requises pour les documents masqués de l’API JavaScript pour Word 1.3

  • Article

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

Lorsque les API de l’ensemble WordApiHiddenDocument de conditions requises sont prises en charge sur toutes les plateformes, elles sont ajoutées à un ensemble de conditions requises publié ultérieurement (WordApi 1.[FUTURE]) et ne sont plus étiquetées comme WordApiHiddenDocument. Considérez cela comme un processus de promotion similaire à celui d’une API passant de la préversion à la mise en production.

Importante

WordApiHiddenDocument 1.3 est un sur-ensemble de l’ensemble de conditions requises WordApi 1.3 et est un ensemble de conditions requises pour le bureau uniquement.

Étant donné que WordApiHiddenDocument les API sont uniquement prises en charge par Word sur Windows et sur Mac, votre complément doit vérifier 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("WordApiHiddenDocument", "1.3")) {
   // Any API exclusive to this desktop-only requirement set.
}

Une fois que l’API est dans un ensemble de conditions requises multiplateforme, vous devez supprimer ou modifier la isSetSupported vérification. 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 WordApiHiddenDocument 1.3 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 API JavaScript Word actuellement incluses dans l’ensemble de WordApiHiddenDocument conditions requises. Pour obtenir la liste complète de toutes les API JavaScript Word (y compris WordApiHiddenDocument les API et les API précédemment publiées), consultez toutes les API JavaScript word.

Classe Champs Description
DocumentCreated body Obtient l’objet body du document.
contentControls Obtient la collection d’objets de contrôle de contenu dans le document.
properties Obtient les propriétés 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.

Voir aussi