Nur online verfügbares Anforderungsset für Excel-JavaScript-API

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 (die keinen undokumentierten Verhaltens- oder Strukturänderungen unterliegen) 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 ExcelApiOnline Anforderungssatz auf allen Plattformen unterstützt werden, werden sie dem nächsten veröffentlichten Anforderungssatz hinzugefügt (ExcelApi 1.[NEXT]). Sobald dieser neue Anforderungssatz öffentlich ist, werden diese APIs aus ExcelApiOnlineentfernt. Stellen Sie sich dies als einen ähnlichen Werbeprozess wie eine API vor, die von der Vorschau 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 in Excel im Web den Benutzern immer eine einzige Version zur Verfügung steht, nämlich die neueste Version.

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

Funktionsbereich Beschreibung Relevante Objekte
Verknüpfte Arbeitsmappen Verwalten von Verknüpfungen zwischen Arbeitsmappen, einschließlich der Unterstützung für das Aktualisieren und Aufheben von Arbeitsmappenverknüpfungen. LinkedWorkbook, LinkedWorkbookCollection
Benannte Blattansichten Ermöglicht die programmgesteuerte Steuerung von Arbeitsblattansichten pro Benutzer. NamedSheetView, NamedSheetViewCollection
Ereignisse zum Verschieben von Arbeitsblättern 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 prüfen, ob der Anforderungssatz unterstützt wird, bevor es diese APIs aufruft. 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. Testen Sie das Feature unbedingt auf diesen Plattformen, wenn Sie diese Änderung vornehmen.

Wichtig

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

API-Liste

In der folgenden Tabelle sind die Excel-JavaScript-APIs aufgeführt, die ExcelApiOnline derzeit im Anforderungssatz 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 dem AllowEditRangeCollection.
isPasswordProtected Gibt an, ob das Objekt kennwortgeschützt 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 dem Objekt zugeordnete Kennwort.
title Gibt den Titel des Objekts an.
AllowEditRangeCollection add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions) Fügt dem Arbeitsblatt ein AllowEditRange Objekt hinzu.
getCount() Gibt die Anzahl der AllowEditRange Objekte in der Sammlung zurück.
getItem(key: string) Ruft das AllowEditRange Objekt anhand seines Titels ab.
getItemAt(index: number) Gibt ein AllowEditRange Objekt anhand seines Index 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 auf diesem Arbeitsblatt gefundenen Objekte an, die das angegebene Kennwort für den Benutzer in der aktuellen Sitzung aufweisen.
AllowEditRangeOptions password Das mit der AllowEditRangeDatei verbundene Kennwort.
LinkedWorkbook breakLinks() Stellt eine Anforderung zum Aufheben der Verknüpfungen, die auf die verknüpfte Arbeitsmappe verweisen.
id Die ursprüngliche URL, die auf die verknüpfte Arbeitsmappe verweist.
refresh() Stellt eine Anforderung zum Aktualisieren der Daten aus der verknüpften Arbeitsmappe.
LinkedWorkbookCollection breakAllLinks() Bricht alle Verknüpfungen zu den verknüpften Arbeitsmappen auf.
getItem(key: string) Ruft Informationen zu einer verknüpften Arbeitsmappe anhand der URL ab.
getItemOrNullObject(key: string) Ruft Informationen zu einer verknüpften Arbeitsmappe anhand der URL ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
refreshAll() Stellt eine Anforderung zum Aktualisieren aller Arbeitsmappenverknüpfungen.
workbookLinksRefreshMode Stellt den Aktualisierungsmodus der Arbeitsmappenverknüpfungen dar.
NamedSheetView activate() Aktiviert diese Tabellenansicht.
delete() Entfernt die Blattansicht aus dem Arbeitsblatt.
duplizieren(Name?: Zeichenfolge) Erstellt eine Kopie dieser Tabellenansicht.
name Gibt den Namen der Tabellenansicht an.
NamedSheetViewCollection add(name: string) Erstellt eine neue Blattansicht mit dem angegebenen Namen.
enterTemporary() Erstellt und aktiviert eine neue temporäre Blattansicht.
exit() Beendet die derzeit aktive Tabellenansicht.
getActive() Ruft die aktuell aktive Tabellenansicht des Arbeitsblatts ab.
getCount() Ruft die Anzahl der Blattansichten in diesem Arbeitsblatt ab.
getItem(key: string) Ruft eine Tabellenansicht unter Verwendung ihres Namens ab.
getItemAt(index: number) Ruft eine Tabellenansicht anhand ihres Index in der Sammlung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
TableRowCollection deleteRows(rows: number[] | Tabellenzeile[]) Löschen mehrerer Zeilen aus einer Tabelle.
deleteRowsAt(index: number, count?: number) Eine angegebene Anzahl von Zeilen aus einer Tabelle löschen, 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 auf dem Arbeitsblatt vorhanden sind.
WorksheetProtection allowEditRanges Gibt das in diesem Arbeitsblatt gefundene AllowEditRangeCollection 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 kennwortgeschützt 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 dem Objekt zugeordnete WorksheetProtection Kennwort.
updateOptions(options: Excel.WorksheetProtectionOptions) Ändern Sie die dem WorksheetProtection Objekt zugeordneten Arbeitsblattschutzoptionen.
WorksheetProtectionChangedEventArgs allowEditRangesChanged Gibt an, ob sich eines der AllowEditRange Objekte geändert hat.
protectionOptionsChanged Gibt an, ob sie WorksheetProtectionOptions sich geändert haben.
sheetPasswordChanged Gibt an, ob sich das Arbeitsblattkennwort geändert hat.

Siehe auch

  • Last updated on