Excel-JavaScript-API (nur Desktop-Anforderungssatz) 1.1

Der ExcelApiDesktop Anforderungssatz ist ein spezieller Anforderungssatz, der Features enthält, die nur in Excel für Windows und Excel für Mac verfügbar sind. APIs in diesem Anforderungssatz gelten als Produktions-APIs für die Excel-Anwendung unter Windows und Mac. Sie befolgen die Supportrichtlinien von Microsoft 365 für Entwickler. ExcelApiDesktop APIs gelten als "Vorschau"-APIs für andere Plattformen (z. B. Web und iPad) und werden möglicherweise von keiner dieser Plattformen unterstützt.

Wenn APIs im ExcelApiDesktop 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 auch weiterhin in diesem ExcelApiDesktop Anforderungssatz markiert. Weitere Informationen zu plattformspezifischen Anforderungen im Allgemeinen finden Sie unter Grundlegendes zu plattformspezifischen Anforderungssätzen.

Wichtig

ExcelApiDesktop 1.1 ist ein reiner Desktop-Anforderungssatz. Es handelt sich um eine Obermenge von ExcelApi 1.21.

Da die ExcelApiDesktop 1.1 APIs nur von Excel unter Windows und Mac unterstützt werden, sollte Ihr Add-In prüfen, ob der Anforderungssatz unterstützt wird, bevor es diese APIs aufruft. Dadurch wird jeder Versuch vermieden, reine Desktop-APIs auf einer nicht unterstützten Plattform zu verwenden.

if (Office.context.requirements.isSetSupported("ExcelApiDesktop", "1.1")) {
   // Any API exclusive to this ExcelApiDesktop 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 ExcelApiDesktop 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 ExcelApiDesktop 1.1 derzeit im Anforderungssatz enthalten sind. Eine vollständige Liste aller Excel-JavaScript-APIs (einschließlich ExcelApiDesktop 1.1 APIs und zuvor veröffentlichter APIs) finden Sie unter Alle Excel-JavaScript-APIs.

Klasse Felder Beschreibung
Anwendung activeWindow Gibt ein window Objekt zurück, das das aktive Fenster darstellt (das Fenster im oberen Bereich).
checkSpelling(word: string, options?: Excel.CheckSpellingOptions) Prüft die Rechtschreibung eines einzelnen Worts.
enterEditingMode() Wechselt in den Bearbeitungsmodus für den ausgewählten Bereich im aktiven Arbeitsblatt.
union(firstRange: Bereich | RangeAreas, secondRange: Bereich | RangeAreas, ... additionalRanges: (Bereich | RangeAreas)[]) Gibt ein RangeAreas Objekt zurück, das die Vereinigung von zwei oder mehreren RangeRangeAreas Objekten darstellt.
Fenster Gibt alle geöffneten Excel-Fenster zurück.
CheckSpellingOptions customDictionary Optional.
ignoreUppercase Optional.
HeaderFooter centerFooterPicture Ruft ein HeaderFooterPicture Objekt ab, das das Bild für den mittleren Abschnitt der Fußzeile darstellt.
centerHeaderPicture Ruft ein HeaderFooterPicture Objekt ab, das das Bild für den mittleren Abschnitt der Kopfzeile darstellt.
leftFooterPicture Ruft ein HeaderFooterPicture Objekt ab, das das Bild für den linken Abschnitt der Fußzeile darstellt.
leftHeaderPicture Ruft ein HeaderFooterPicture Objekt ab, das das Bild für den linken Abschnitt der Kopfzeile darstellt.
rightFooterPicture Ruft ein HeaderFooterPicture Objekt ab, das das Bild für den rechten Abschnitt der Fußzeile darstellt.
rightHeaderPicture Ruft ein HeaderFooterPicture Objekt ab, das das Bild für den rechten Abschnitt der Kopfzeile darstellt.
HeaderFooterPicture Helligkeit Gibt die Helligkeit des Bilds an.
colorType Gibt den Typ der Farbtransformation des Bilds an.
Kontrast Gibt den Kontrast des Bilds an.
cropBottom Gibt die Anzahl der Punkte an, die am unteren Rand des Bilds abgeschnitten werden.
cropLeft Gibt die Anzahl der Punkte an, die auf der linken Seite des Bilds abgeschnitten werden.
cropRight Gibt die Anzahl der Punkte an, die auf der rechten Seite des Bilds abgeschnitten werden.
cropTop Gibt die Anzahl der Punkte an, die am oberen Rand des Bilds abgeschnitten werden.
Dateiname Gibt die URL (im Intranet oder Web) oder den Pfad (lokal oder im Netzwerk) zu dem Speicherort an, an dem das Quellobjekt gespeichert wird.
height Gibt die Höhe des Bilds in Punkt an.
lockAspectRatio Gibt einen Wert an, der angibt, ob das Bild seine ursprünglichen Proportionen beibehält, wenn die Größe geändert wird.
width Gibt die Breite des Bilds in Punkten an.
Image Helligkeit Gibt die Helligkeit des Bilds an.
colorType Gibt den Typ der Farbtransformation an, die auf das Bild angewendet wird.
Kontrast Gibt den Kontrast des Bilds an.
cropBottom Gibt die Anzahl der Punkte an, die am unteren Rand des Bilds abgeschnitten werden.
cropLeft Gibt die Anzahl der Punkte an, die auf der linken Seite des Bilds abgeschnitten werden.
cropRight Gibt die Anzahl der Punkte an, die auf der rechten Seite des Bilds abgeschnitten werden.
cropTop Gibt die Anzahl der Punkte an, die oben im Bild abgeschnitten werden.
incrementBrightness(increment: number) Erhöht die Helligkeit des Bilds um einen angegebenen Wert.
incrementContrast(increment: number) Erhöht den Kontrast des Bilds um einen angegebenen Wert.
PageLayout alignMarginsHeaderFooter Gibt an, ob Excel die Kopf- und Fußzeile an den Rändern ausrichtet, die in den Seiteneinrichtungsoptionen festgelegt sind.
printQuality Gibt ein Array mit zwei Elementen an, das sowohl horizontale als auch vertikale Druckqualitätswerte enthält.
Fensterausschnitt Index Gibt den Index des Bereichs zurück.
PaneCollection getCount() Gibt die Anzahl der Bereiche in der Sammlung zurück.
getItemAt(index: number) Ruft den Bereich in der Sammlung nach Index ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
Range checkSpelling(options?: Excel.CheckSpellingOptions) Überprüft die Rechtschreibung von Wörtern in diesem Bereich.
formulaArray Gibt die Arrayformel eines Bereichs an.
showDependents(remove?: boolean) Zeichnet Spurpfeile zu den direkten Nachfolgern des Bereichs.
showPrecedents(entfernen?: boolescher Wert) Zeichnet Spurpfeile zu den direkten Vorgängerzellen des Bereichs.
Window activate() Aktiviert das Fenster.
activateNext() Aktiviert das nächste Fenster.
activatePrevious() Aktiviert das vorherige Fenster.
activeCell Ruft die aktive Zelle im Fenster ab.
activePane Ruft den aktiven Bereich im Fenster ab.
activeWorksheet Ruft das aktive Arbeitsblatt im Fenster ab.
autoFilterDateGroupingEnabled Gibt an, ob die AutoFilter-Datumsgruppierung im Fenster aktiviert ist.
schließen() Schließt das Fenster.
enableResize Gibt an, ob die Größenänderung für das Fenster aktiviert ist.
freezePanes Gibt an, ob Bereiche im Fenster fixiert sind.
height Gibt die Höhe des Fensters an.
Index Ruft den Index des Fensters ab.
isVisible Gibt an, ob das Fenster sichtbar ist.
largeScroll(down: number, up: number, ToRight: number, ToLeft: number) Scrollt im Fenster um mehrere Seiten.
left Gibt den Abstand in Punkt vom linken Rand des Computerbildschirms zum linken Rand des Fensters an.
name Gibt den Namen des Fensters an.
newWindow() Öffnet ein neues Excel-Fenster.
Bereiche Ruft eine Sammlung der mit dem Fenster verknüpften Bereiche ab.
pointsToScreenPixelsX(Punkte: Zahl) Wandelt horizontale Punkte in Bildschirmpixel um.
pointsToScreenPixelsY(Punkte: Zahl) Wandelt vertikale Punkte in Bildschirmpixel um.
scrollColumn Gibt die Bildlaufspalte des Fensters an.
scrollIntoView(Links: Zahl, Oben: Zahl, Breite: Zahl, Höhe: Zahl, Start?: boolesch) Scrollt im Fenster, um den angegebenen Bereich sichtbar zu machen.
scrollRow Gibt die Bildlaufzeile des Fensters an.
scrollWorkbookTabs(Sheets?: Zahl, Position?: Excel.ScrollWorkbookTabPosition) Scrollt durch die Arbeitsmappenregisterkarten.
showFormulas Gibt an, ob Formeln im Fenster angezeigt werden.
showGridlines Gibt an, ob Gitternetzlinien im Fenster angezeigt werden.
showHeadings Gibt an, ob Überschriften im Fenster angezeigt werden.
showHorizontalScrollBar Gibt an, ob die horizontale Bildlaufleiste im Fenster angezeigt wird.
showOutline Gibt an, ob die Kontur im Fenster angezeigt wird.
showRightToLeft Ruft den Layoutwert für das Layout von rechts nach links ab.
showRuler Gibt an, ob das Lineal im Fenster angezeigt wird.
showVerticalScrollBar Gibt an, ob die vertikale Bildlaufleiste im Fenster angezeigt wird.
showWhitespace Gibt an, ob Leerzeichen im Fenster angezeigt werden.
showWorkbookTabs Gibt an, ob Arbeitsmappenregisterkarten im Fenster angezeigt werden.
showZeros Gibt an, ob Nullen im Fenster angezeigt werden.
smallScroll(down: number, up: number, ToRight: number, ToLeft: number) Scrollt das Fenster um eine Reihe von Zeilen oder Spalten.
Teilen Gibt den geteilten Zustand des Fensters an.
Spalte teilen Gibt die geteilte Spalte des Fensters an.
splitHorizontal Gibt die horizontale Aufteilung des Fensters an.
splitRow Gibt die geteilte Zeile des Fensters an.
splitVertical Gibt die vertikale Aufteilung des Fensters an.
tabRatio Gibt das Registerkartenverhältnis des Fensters an.
top Gibt den Abstand in Punkten vom oberen Rand des Fensters zum oberen Rand des nutzbaren Bereichs an (unterhalb der Menüs, aller oben angedockten Symbolleisten und der Bearbeitungsleiste).
type Gibt den Typ des Fensters an.
usableHeight Ruft die nutzbare Höhe des Fensters ab.
usableWidth Ruft die nutzbare Breite des Fensters ab.
view Gibt die Ansicht des Fensters an.
visibleRange Ruft den sichtbaren Bereich des Fensters ab.
width Gibt die Anzeigebreite des Fensters an.
windowNumber Ruft die Fensternummer ab.
windowState Gibt den Fensterstatus an.
zoom Gibt einen ganzzahligen Wert an, der die Anzeigegröße des Fensters darstellt.
WindowCollection breakSideBySide() Unterbrochen die parallele Ansicht von Fenstern.
compareCurrentSideBySideWith(windowName: string) Vergleicht das aktuelle Fenster Seite an Seite mit dem angegebenen Fenster.
getCount() Ruft die Anzahl der Fenster in der Sammlung ab.
getItemAt(index: number) Ruft das Fenster in der Sammlung nach Index ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
resetPositionsSideBySide() Setzt die Positionen von Fenstern nebeneinander zurück.
Workbook focus() Legt den Fokus auf die Arbeitsmappe fest.
Arbeitsblatt checkSpelling(options?: Excel.CheckSpellingOptions) Überprüft die Rechtschreibung der Wörter in diesem Arbeitsblatt.
clearArrows() Löscht die Spurpfeile auf dem Arbeitsblatt.
evaluate(name: string) Gibt das Auswertungsergebnis einer Formelzeichenfolge zurück.

Siehe auch

  • Last updated on