Ensemble de conditions requises pour l’API JavaScript Excel en ligne uniquement

  • Article

L’ensemble ExcelApiOnline de conditions requises est un ensemble de conditions requises spécial qui inclut des fonctionnalités qui ne sont disponibles que pour Excel sur le Web. Les API de cet ensemble de conditions requises sont considérées comme des API de production (non soumises à des modifications comportementales ou structurelles non documentées) pour l’application Excel sur le Web. ExcelApiOnline Les API sont considérées comme des API « en préversion » pour d’autres plateformes (Windows, Mac, iOS) et peuvent ne pas être prises en charge par l’une de ces plateformes.

Lorsque les API de l’ensemble ExcelApiOnline de conditions requises sont prises en charge sur toutes les plateformes, elles sont ajoutées à l’ensemble de conditions requises suivant (ExcelApi 1.[NEXT]). Une fois que cette nouvelle exigence est publique, ces API sont supprimées de ExcelApiOnline. Considérez cela comme un processus de promotion similaire à celui d’une API passant de la préversion à la mise en production.

Importante

ExcelApiOnline est un sur-ensemble du dernier ensemble de conditions requises numérotées.

Importante

ExcelApiOnline 1.1 est la seule version des API en ligne uniquement. Cela est dû au fait que Excel sur le Web disposez toujours d’une seule version disponible pour les utilisateurs qui est la dernière version.

Le tableau suivant fournit un résumé concis des API, tandis que le tableau de liste d’API suivant fournit une liste détaillée des API actuelles ExcelApiOnline .

Fonctionnalité Description Objets pertinents
Classeurs liés Gérer les liens entre les classeurs, y compris la prise en charge de l’actualisation et de la rupture des liens de classeur. LinkedWorkbook, LinkedWorkbookCollection
Affichages de feuille nommés Permet de contrôler par programmation les affichages de feuille de calcul par utilisateur. NamedSheetView, NamedSheetViewCollection
Événements de déplacement de feuille de calcul Détecter quand des feuilles de calcul sont déplacées dans une collection, la position de la feuille de calcul et la source de la modification. WorksheetCollection, WorksheetMovedEventArgs
Protection de feuille de calcul Empêcher les utilisateurs non autorisés d’apporter des modifications aux plages spécifiées dans une feuille de calcul. WorksheetProtection, AllowEditRange, AllowEditRangeCollection, AllowEditRangeOptions

Étant donné que ExcelApiOnline les API ne sont prises en charge que par Excel sur le Web, votre complément doit case activée si l’ensemble de conditions requises est pris en charge avant d’appeler ces API. Cela évite d’appeler une API en ligne uniquement sur une autre plateforme.

if (Office.context.requirements.isSetSupported("ExcelApiOnline", "1.1")) {
   // Any API exclusive to the ExcelApiOnline 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 ExcelApiOnline 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 API JavaScript Excel actuellement incluses dans l’ensemble de conditions ExcelApiOnline requises. Pour obtenir la liste complète de toutes les API JavaScript Excel (y compris ExcelApiOnline les API et les API précédemment publiées), consultez toutes les API JavaScript Excel.

Classe Champs Description
AllowEditRange adresse Spécifie la plage associée à l’objet .
delete() Supprime l’objet du AllowEditRangeCollection.
isPasswordProtected Spécifie si l’objet est protégé par mot de passe.
pauseProtection(password?: string) Suspend la protection de la feuille de calcul pour l’objet pour l’utilisateur dans la session active.
setPassword(password?: string) Modifie le mot de passe associé à l’objet .
title Spécifie le titre de l’objet.
AllowEditRangeCollection add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions) Ajoute un AllowEditRange objet à la feuille de calcul.
getCount() Retourne le nombre d’objets dans AllowEditRange la collection.
getItem(key: string) Obtient l’objet AllowEditRange par son titre.
getItemAt(index: number) Retourne un AllowEditRange objet par son index dans la collection.
getItemOrNullObject(key: string) Obtient l’objet AllowEditRange par son titre.
items Obtient l’élément enfant chargé dans cette collection de sites.
pauseProtection(password: string) Suspend la protection de la feuille de calcul pour tous les AllowEditRange objets de cette feuille de calcul qui ont le mot de passe donné à l’utilisateur dans la session active.
AllowEditRangeOptions mot de passe Mot de passe associé à .AllowEditRange
LinkedWorkbook breakLinks() Effectue une demande pour arrêter les liens pointant vers le classeur lié.
id URL d’origine pointant vers le classeur lié.
refresh() Effectue une demande d’actualisation des données récupérées à partir du classeur lié.
LinkedWorkbookCollection breakAllLinks() Interrompt tous les liens vers les classeurs liés.
getItem(key: string) Obtient des informations sur un classeur lié par son URL.
getItemOrNullObject(key: string) Obtient des informations sur un classeur lié par son URL.
items Obtient l’élément enfant chargé dans cette collection de sites.
refreshAll() Effectue une demande d’actualisation de tous les liens de classeur.
workbookLinksRefreshMode Représente le mode de mise à jour des liens de classeur.
NamedSheetView activate() Active cette vue de feuille.
delete() Supprime l’affichage feuille de la feuille de calcul.
duplicate(name?: string) Crée une copie de cette vue de feuille.
name Obtient ou définit le nom de l’affichage feuille.
NamedSheetViewCollection add(name: string) Crée une vue feuille avec le nom donné.
enterTemporary() Crée et active une nouvelle vue de feuille temporaire.
exit() Quitte l’affichage feuille actuellement actif.
getActive() Obtient l’affichage feuille actuellement actif de la feuille de calcul.
getCount() Obtient le nombre d’affichages de feuille dans cette feuille de calcul.
getItem(key: string) Obtient une vue de feuille à l’aide de son nom.
getItemAt(index: number) Obtient une vue feuille par son index dans la collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
TableRowCollection deleteRows(rows: number[] | TableRow[]) Supprimer plusieurs lignes d’une table.
deleteRowsAt(index: number, count?: number) Supprimer un nombre spécifié de lignes d’une table, en commençant à un index donné.
Classeur linkedWorkbooks Retourne une collection de classeurs liés.
Feuille de calcul namedSheetViews Retourne une collection d’affichages feuille qui sont présents dans la feuille de calcul.
WorksheetProtection allowEditRanges Spécifie l’objet AllowEditRangeCollection trouvé dans cette feuille de calcul.
canPauseProtection Spécifie si la protection peut être suspendue pour cette feuille de calcul.
checkPassword(password?: string) Spécifie si le mot de passe peut être utilisé pour déverrouiller la protection de feuille de calcul.
isPasswordProtected Spécifie si la feuille est protégée par mot de passe.
isPaused Spécifie si la protection de la feuille de calcul est suspendue.
pauseProtection(password?: string) Suspend la protection de la feuille de calcul pour l’objet de feuille de calcul donné pour l’utilisateur de la session active.
resumeProtection() Reprend la protection de feuille de calcul pour l’objet de feuille de calcul donné pour l’utilisateur dans une session donnée.
savedOptions Spécifie les options de protection enregistrées dans la feuille de calcul.
setPassword(password?: string) Modifie le mot de passe associé à l’objet WorksheetProtection .
updateOptions(options : Excel.WorksheetProtectionOptions) Modifiez les options de protection de feuille de calcul associées à l’objet WorksheetProtection .
WorksheetProtectionChangedEventArgs allowEditRangesChanged Spécifie si l’un AllowEditRange des objets a changé.
protectionOptionsChanged Spécifie si ont changé.WorksheetProtectionOptions
sheetPasswordChanged Spécifie si le mot de passe de la feuille de calcul a été modifié.

Voir aussi