Jeu de conditions préalables en ligne uniquement de l’API JavaScript d’Excel

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

Lorsque les API de l’ensemble d’exigences ExcelApiOnline sont prises en charge sur toutes les plateformes, elles sont ajoutées au prochain ensemble d’exigences publié (ExcelApi 1.[NEXT]). Une fois que ce nouvel ensemble de conditions requises sera public, ces API seront supprimées de ExcelApiOnline. Considérez cela comme un processus de promotion similaire à une API passant de la préversion à la version.

Importante

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

Importante

ExcelApiOnline 1.1 est la seule version des API en ligne uniquement. Cela est dû au fait qu’Excel sur le Web dispose toujours d’une version unique 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 des API suivant fournit une liste détaillée des API actuelles ExcelApiOnline .

Fonctionnalité Description Objets pertinents
Classeurs liés Gérez les liens entre classeurs, y compris la prise en charge de l’actualisation et de la rupture des liens de classeur. LinkedWorkbook, LinkedWorkbookCollection
Affichages des feuilles nommées Fournit un contrôle par programme des affichages de feuilles 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 au sein d’une collection, la position de la feuille de calcul et la source de la modification. WorksheetCollection, WorksheetMovedEventArgs
Protection de la 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é ExcelApiOnline que les API ne sont prises en charge que par Excel sur le Web, votre complément doit case activée si l’ensemble des 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 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 ExcelApiOnline 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 Excel actuellement incluses dans le jeu de ExcelApiOnline conditions. Pour obtenir la liste complète de toutes les API JavaScript Excel (y compris ExcelApiOnline les API et les API publiées précédemment), voir toutes les API Excel JavaScript.

Classe Champs Description
AllowEditRange adresse Spécifie la plage associée à l’objet.
delete() Supprime l’objet du AllowEditRangeCollection.
isPasswordProtected Indique si l’objet est protégé par mot de passe.
pauseProtection(password ?: string) Suspend la protection de la feuille de calcul de 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() Renvoie le nombre d’objets AllowEditRange dans la collection.
getItem(key: string) Récupère l’objet AllowEditRange par son titre.
getItemAt(index: number) Renvoie un AllowEditRange objet par son index dans la collection.
getItemOrNullObject(key: string) Récupère l’objet AllowEditRange par son titre.
items Obtient l’élément enfant chargé dans cette collection de sites.
pauseProtection(password : string) Interrompt la protection de la feuille de calcul pour tous les AllowEditRange objets trouvés dans cette feuille de calcul qui ont le mot de passe donné pour l’utilisateur dans la session active.
AllowEditRangeOptions mot de passe Mot de passe associé au AllowEditRangefichier .
LinkedWorkbook breakLinks() Effectue une demande pour rompre les liaisons 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() Rompt 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() Effectuer une demande d’actualisation de tous les liens du classeur.
workbookLinksRefreshMode Représente le mode de mise à jour des liens du classeur.
NamedSheetView activate() Active cet affichage de feuille.
delete() Supprime l’affichage de feuille de la feuille de calcul.
duplicate(nom ?: chaîne) Crée une copie de cet affichage de feuille.
name Spécifie le nom de l’affichage de feuille.
NamedSheetViewCollection add(name: string) Crée un nouvel affichage de feuille avec le nom donné.
enterTemporary() Crée et active un nouvel affichage de feuille temporaire.
sortie() Quitte la vue de feuille actuellement active.
getActive() Obtient l’affichage de feuille actuellement actif de la feuille de calcul.
getCount() Obtient le nombre de feuilles vues dans cette feuille de calcul.
getItem(key: string) Obtient un affichage de feuille en utilisant son nom.
getItemAt(index: number) Obtient un affichage de 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’un tableau.
deleteRowsAt(index : number, count ?: number) Supprimez un nombre spécifié de lignes d’une table, à partir d’un index donné.
Classeur Classeurs liés Renvoie une collection de classeurs liés.
Feuille de calcul namedSheetViews Renvoie un ensemble de feuilles personnelles présentes 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) Indique si le mot de passe peut être utilisé pour déverrouiller la protection de la feuille de calcul.
isPasswordProtected Indique 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 dans la session active.
resumeProtection() Reprend la protection de la 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) Modifier les options de protection de la feuille de calcul associées à l’objet WorksheetProtection .
WorksheetProtectionChangedEventArgs allowEditRangesChanged Spécifie si l’un AllowEditRange des objets a changé.
protectionOptionsChanged Spécifie si les WorksheetProtectionOptions ont changé.
sheetPasswordChanged Indique si le mot de passe de la feuille de calcul a changé.

Voir aussi

  • Last updated on