Nur Onlineanforderungssatz für die JavaScript-API für Excel

  • Artikel

Der ExcelApiOnline Anforderungssatz ist ein spezieller Anforderungssatz, der Features enthält, die nur für Excel im Web verfügbar sind. APIs in diesem Anforderungssatz gelten als Produktions-APIs (unterliegen nicht dokumentierten Verhaltens- oder Strukturänderungen) für die Excel im Web-Anwendung. ExcelApiOnline APIs gelten als "Vorschau"-APIs für andere Plattformen (Windows, Mac, iOS) und werden möglicherweise von keiner dieser Plattformen unterstützt.

Wenn APIs im Anforderungssatz ExcelApiOnline plattformübergreifend unterstützt werden, werden sie dem nächsten freigegebenen Anforderungssatz (ExcelApi 1.[NEXT]) hinzugefügt. Sobald diese neue Anforderung öffentlich ist, werden diese APIs aus ExcelApiOnlineentfernt. Stellen Sie sich dies als einen ähnlichen Heraufstufungsprozess für eine API vor, die von der Vorschauversion zur Veröffentlichung wechselt.

Wichtig

ExcelApiOnline ist eine Obermenge des letzten nummerierten Anforderungssatzes.

Wichtig

ExcelApiOnline 1.1 ist die einzige Version der nur online verfügbaren APIs. Dies liegt daran, dass Excel im Web benutzern immer eine einzelne Version zur Verfügung steht, die die neueste Version ist.

Die folgende Tabelle enthält eine kurze Zusammenfassung der APIs, während die nachfolgende API-Listentabelle eine detaillierte Liste der aktuellen ExcelApiOnline APIs enthält.

Funktionsbereich Beschreibung Relevante Objekte
Verknüpfte Arbeitsmappen Verwalten von Links zwischen Arbeitsmappen, einschließlich Unterstützung für das Aktualisieren und Unterbrechen von Arbeitsmappenverknüpfungen. LinkedWorkbook, LinkedWorkbookCollection
Benannte Blattansichten Ermöglicht die programmgesteuerte Steuerung von Benutzerarbeitsblattansichten. NamedSheetView, NamedSheetViewCollection
Arbeitsblattverschiebungsereignisse Erkennen, wann Arbeitsblätter innerhalb einer Sammlung verschoben werden, die Position des Arbeitsblatts und die Quelle der Änderung. WorksheetCollection, WorksheetMovedEventArgs
Arbeitsblattschutz Verhindern, dass nicht autorisierte Benutzer Änderungen an angegebenen Bereichen innerhalb eines Arbeitsblatts vornehmen. WorksheetProtection, AllowEditRange, AllowEditRangeCollection, AllowEditRangeOptions

Da ExcelApiOnline APIs nur von Excel im Web unterstützt werden, sollte Ihr Add-In überprüfen, ob der Anforderungssatz unterstützt wird, bevor diese APIs aufgerufen werden. Dadurch wird vermieden, dass eine reine Online-API auf einer anderen Plattform aufgerufen wird.

if (Office.context.requirements.isSetSupported("ExcelApiOnline", "1.1")) {
   // Any API exclusive to the ExcelApiOnline requirement set.
}

Sobald sich die API in einem plattformübergreifenden Anforderungssatz befindet, sollten Sie die isSetSupported Überprüfung entfernen oder bearbeiten. Dadurch wird das Feature Ihres Add-Ins auf anderen Plattformen aktiviert. Stellen Sie sicher, dass Sie das Feature auf diesen Plattformen testen, wenn Sie diese Änderung vornehmen.

Wichtig

Ihr Manifest kann nicht als Aktivierungsanforderung angeben ExcelApiOnline 1.1 . Es ist kein gültiger Wert, der im Set-Element verwendet werden kann.

API-Liste

In der folgenden Tabelle sind die Excel-JavaScript-APIs aufgeführt, die derzeit im Anforderungssatz ExcelApiOnline enthalten sind. Eine vollständige Liste aller Excel-JavaScript-APIs (einschließlich ExcelApiOnline APIs und zuvor veröffentlichter APIs) finden Sie unter Alle Excel-JavaScript-APIs.

Klasse Felder Beschreibung
AllowEditRange address Gibt den Bereich an, der dem -Objekt zugeordnet ist.
delete() Löscht das -Objekt aus der AllowEditRangeCollection.
isPasswordProtected Gibt an, ob das Objekt kennwortsicher ist.
pauseProtection(password?: string) Hält den Arbeitsblattschutz für das Objekt für den Benutzer in der aktuellen Sitzung an.
setPassword(password?: string) Ändert das Kennwort, das dem -Objekt zugeordnet ist.
title Gibt den Titel des Objekts an.
AllowEditRangeCollection add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions) Fügt dem Arbeitsblatt ein -Objekt hinzu AllowEditRange .
getCount() Gibt die Anzahl der AllowEditRange Objekte in der Auflistung zurück.
getItem(key: string) Ruft das AllowEditRange -Objekt anhand seines Titels ab.
getItemAt(index: number) Gibt ein AllowEditRange Objekt anhand seines Indexes in der Auflistung zurück.
getItemOrNullObject(key: string) Ruft das AllowEditRange -Objekt anhand seines Titels ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
pauseProtection(password: string) Hält den Arbeitsblattschutz für alle AllowEditRange Objekte in diesem Arbeitsblatt an, die über das für den Benutzer in der aktuellen Sitzung angegebene Kennwort verfügen.
AllowEditRangeOptions password Das Kennwort, das dem zugeordnet ist AllowEditRange.
LinkedWorkbook breakLinks() Sendet eine Anforderung zum Unterbrechen der Links, die auf die verknüpfte Arbeitsmappe verweisen.
id Die ursprüngliche URL, die auf die verknüpfte Arbeitsmappe verweist.
refresh() Sendet eine Anforderung zum Aktualisieren der aus der verknüpften Arbeitsmappe abgerufenen Daten.
LinkedWorkbookCollection breakAllLinks() Unterbricht alle Links zu den verknüpften Arbeitsmappen.
getItem(key: string) Ruft Informationen zu einer verknüpften Arbeitsmappe anhand ihrer URL ab.
getItemOrNullObject(key: string) Ruft Informationen zu einer verknüpften Arbeitsmappe anhand ihrer URL ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
refreshAll() Sendet eine Anforderung zum Aktualisieren aller Arbeitsmappenlinks.
workbookLinksRefreshMode Stellt den Aktualisierungsmodus der Arbeitsmappenlinks dar.
NamedSheetView activate() Aktiviert diese Blattansicht.
delete() Entfernt die Blattansicht aus dem Arbeitsblatt.
duplicate(name?: string) Erstellt eine Kopie dieser Blattansicht.
name Ruft den Namen der Blattansicht ab oder legt den Namen fest.
NamedSheetViewCollection add(name: string) Erstellt eine neue Blattansicht mit dem angegebenen Namen.
enterTemporary() Erstellt und aktiviert eine neue temporäre Blattansicht.
exit() Beendet die aktuell aktive Blattansicht.
getActive() Ruft die aktuell aktive Blattansicht des Arbeitsblatts ab.
getCount() Ruft die Anzahl der Blattansichten in diesem Arbeitsblatt ab.
getItem(key: string) Ruft eine Blattansicht unter Verwendung ihres Namens ab.
getItemAt(index: number) Ruft eine Blattansicht anhand ihres Indexes in der Auflistung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
TableRowCollection deleteRows(rows: number[] | TableRow[]) Löschen mehrerer Zeilen aus einer Tabelle.
deleteRowsAt(index: number, count?: number) Löscht eine angegebene Anzahl von Zeilen aus einer Tabelle, beginnend bei einem bestimmten Index.
Workbook linkedWorkbooks Gibt eine Auflistung verknüpfter Arbeitsmappen zurück.
Arbeitsblatt namedSheetViews Gibt eine Auflistung von Blattansichten zurück, die im Arbeitsblatt vorhanden sind.
WorksheetProtection allowEditRanges Gibt das AllowEditRangeCollection in diesem Arbeitsblatt gefundene Objekt an.
canPauseProtection Gibt an, ob der Schutz für dieses Arbeitsblatt angehalten werden kann.
checkPassword(password?: string) Gibt an, ob das Kennwort zum Entsperren des Arbeitsblattschutzes verwendet werden kann.
isPasswordProtected Gibt an, ob das Blatt kennwortsicher ist.
isPaused Gibt an, ob der Arbeitsblattschutz angehalten ist.
pauseProtection(password?: string) Hält den Arbeitsblattschutz für das angegebene Arbeitsblattobjekt für den Benutzer in der aktuellen Sitzung an.
resumeProtection() Setzt den Arbeitsblattschutz für das angegebene Arbeitsblattobjekt für den Benutzer in einer bestimmten Sitzung fort.
savedOptions Gibt die im Arbeitsblatt gespeicherten Schutzoptionen an.
setPassword(password?: string) Ändert das Kennwort, das dem WorksheetProtection -Objekt zugeordnet ist.
updateOptions(options: Excel.WorksheetProtectionOptions) Ändern Sie die dem -Objekt zugeordneten WorksheetProtection Arbeitsblattschutzoptionen.
WorksheetProtectionChangedEventArgs allowEditRangesChanged Gibt an, ob eines der AllowEditRange Objekte geändert wurde.
protectionOptionsChanged Gibt an, ob geändert WorksheetProtectionOptions wurde.
sheetPasswordChanged Gibt an, ob das Arbeitsblattkennwort geändert wurde.

Siehe auch