Freigeben über


Excel.Window class

Stellt ein Fenster in der Arbeitsmappe dar.

Extends

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

Eigenschaften

activeCell

Gibt die aktive Zelle im Fenster an.

activePane

Gibt den aktiven Bereich im Fenster an.

activeWorksheet

Gibt das aktive Blatt im Fenster an.

autoFilterDateGroupingEnabled

Gibt an, ob die AutoFilter-Datumsgruppierung im Fenster aktiviert ist.

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

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.

left

Gibt den Abstand in Punkt vom linken Rand des Computerbildschirms zum linken Rand des Fensters an.

name

Gibt den Namen des Fensters an.

panes

Ruft eine Auflistung von Bereichen ab, die dem Fenster zugeordnet sind.

rangeSelection

Ruft die Bereichsauswahl im Fenster ab.

scrollColumn

Gibt die Bildlaufspalte des Fensters an.

scrollRow

Gibt die Bildlaufzeile des Fensters an.

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 Gliederung im Fenster angezeigt wird.

showRightToLeft

Ruft den Rechts-nach-links-Layoutwert des Fensters ab. True bedeutet, dass das Fenster ein Rechts-nach-Links-Layout verwendet, false bedeutet, dass das Fenster das Layout von links nach rechts verwendet.

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 Arbeitsmappenregister im Fenster angezeigt werden.

showZeros

Gibt an, ob Nullen im Fenster angezeigt werden.

split

Gibt den geteilten Zustand des Fensters an.

splitColumn

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 Tabstoppverhältnis des Fensters an.

top

Gibt den Abstand in Punkt vom oberen Rand des Fensters zum oberen Rand des verwendbaren Bereichs an (unterhalb der Menüs, aller oben angedockten Symbolleisten und der Bearbeitungsleiste).

type

Gibt den Typ des Fensters an.

usableHeight

Gibt die verwendbare Höhe des Fensters an.

usableWidth

Gibt die verwendbare Breite des Fensters an.

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. Sie kann auf einen Prozentsatz zwischen 10 und 400 festgelegt werden.

Methoden

activate()

Aktiviert das Fenster.

activateNext()

Aktiviert das nächste Fenster.

activatePrevious()

Aktiviert das vorherige Fenster.

close()

Schließt das Fenster.

largeScroll(Down, Up, ToRight, ToLeft)

Führt einen Bildlauf im Fenster um mehrere Seiten durch. Die downParameter , up, toRightund toLeft entsprechen der Aktion des Bildlaufs mit den Tasten "Bild nach unten", "Bild oben", "ALT+BILD-AB" und "ALT+BILD-AUF" auf der Tastatur.

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

newWindow()

Öffnet ein neues Excel-Fenster.

pointsToScreenPixelsX(Points)

Konvertiert horizontale Punkte in Bildschirmpixel.

pointsToScreenPixelsY(Points)

Konvertiert vertikale Punkte in Bildschirmpixel.

scrollIntoView(Left, Top, Width, Height, Start)

Führt einen Bildlauf im Fenster durch, um den angegebenen Bereich anzuzeigen.

scrollWorkbookTabs(Sheets, Position)

Führt einen Bildlauf auf den Arbeitsmappenregistern durch.

scrollWorkbookTabs(Sheets, Position)

Führt einen Bildlauf auf den Arbeitsmappenregistern durch.

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

smallScroll(Down, Up, ToRight, ToLeft)

Führt einen Bildlauf im Fenster um eine Reihe von Zeilen oder Spalten durch. Die downParameter , up, toRightund toLeft entsprechen der Aktion des Bildlaufs mit Pfeiltasten auf der Tastatur.

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Window Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.WindowData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

activeCell

Gibt die aktive Zelle im Fenster an.

readonly activeCell: Excel.Range;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

activePane

Gibt den aktiven Bereich im Fenster an.

readonly activePane: Excel.Pane;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

activeWorksheet

Gibt das aktive Blatt im Fenster an.

readonly activeWorksheet: Excel.Worksheet;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

autoFilterDateGroupingEnabled

Gibt an, ob die AutoFilter-Datumsgruppierung im Fenster aktiviert ist.

autoFilterDateGroupingEnabled: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

enableResize

Gibt an, ob die Größenänderung für das Fenster aktiviert ist.

readonly enableResize: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

freezePanes

Gibt an, ob Bereiche im Fenster fixiert sind.

freezePanes: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

height

Gibt die Höhe des Fensters an.

height: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

index

Ruft den Index des Fensters ab.

readonly index: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

isVisible

Gibt an, ob das Fenster sichtbar ist.

isVisible: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

left

Gibt den Abstand in Punkt vom linken Rand des Computerbildschirms zum linken Rand des Fensters an.

left: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

name

Gibt den Namen des Fensters an.

name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

panes

Ruft eine Auflistung von Bereichen ab, die dem Fenster zugeordnet sind.

readonly panes: Excel.PaneCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

rangeSelection

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Bereichsauswahl im Fenster ab.

readonly rangeSelection: Excel.RangeAreas;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

scrollColumn

Gibt die Bildlaufspalte des Fensters an.

scrollColumn: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

scrollRow

Gibt die Bildlaufzeile des Fensters an.

scrollRow: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

showFormulas

Gibt an, ob Formeln im Fenster angezeigt werden.

showFormulas: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

showGridlines

Gibt an, ob Gitternetzlinien im Fenster angezeigt werden.

showGridlines: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

showHeadings

Gibt an, ob Überschriften im Fenster angezeigt werden.

showHeadings: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

showHorizontalScrollBar

Gibt an, ob die horizontale Bildlaufleiste im Fenster angezeigt wird.

showHorizontalScrollBar: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

showOutline

Gibt an, ob die Gliederung im Fenster angezeigt wird.

showOutline: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

showRightToLeft

Ruft den Rechts-nach-links-Layoutwert des Fensters ab. True bedeutet, dass das Fenster ein Rechts-nach-Links-Layout verwendet, false bedeutet, dass das Fenster das Layout von links nach rechts verwendet.

readonly showRightToLeft: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

showRuler

Gibt an, ob das Lineal im Fenster angezeigt wird.

showRuler: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

showVerticalScrollBar

Gibt an, ob die vertikale Bildlaufleiste im Fenster angezeigt wird.

showVerticalScrollBar: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

showWhitespace

Gibt an, ob Leerzeichen im Fenster angezeigt werden.

showWhitespace: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

showWorkbookTabs

Gibt an, ob Arbeitsmappenregister im Fenster angezeigt werden.

showWorkbookTabs: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

showZeros

Gibt an, ob Nullen im Fenster angezeigt werden.

showZeros: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

split

Gibt den geteilten Zustand des Fensters an.

split: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

splitColumn

Gibt die geteilte Spalte des Fensters an.

splitColumn: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

splitHorizontal

Gibt die horizontale Aufteilung des Fensters an.

splitHorizontal: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

splitRow

Gibt die geteilte Zeile des Fensters an.

splitRow: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

splitVertical

Gibt die vertikale Aufteilung des Fensters an.

splitVertical: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

tabRatio

Gibt das Tabstoppverhältnis des Fensters an.

tabRatio: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

top

Gibt den Abstand in Punkt vom oberen Rand des Fensters zum oberen Rand des verwendbaren Bereichs an (unterhalb der Menüs, aller oben angedockten Symbolleisten und der Bearbeitungsleiste).

top: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

type

Gibt den Typ des Fensters an.

readonly type: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";

Eigenschaftswert

Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook"

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

usableHeight

Gibt die verwendbare Höhe des Fensters an.

readonly usableHeight: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

usableWidth

Gibt die verwendbare Breite des Fensters an.

readonly usableWidth: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

view

Gibt die Ansicht des Fensters an.

view: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";

Eigenschaftswert

Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView"

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

visibleRange

Ruft den sichtbaren Bereich des Fensters ab.

readonly visibleRange: Excel.Range;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

width

Gibt die Anzeigebreite des Fensters an.

width: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

windowNumber

Ruft die Fensternummer ab.

readonly windowNumber: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

windowState

Gibt den Fensterstatus an.

windowState: Excel.WindowState | "maximized" | "minimized" | "normal";

Eigenschaftswert

Excel.WindowState | "maximized" | "minimized" | "normal"

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

zoom

Gibt einen ganzzahligen Wert an, der die Anzeigegröße des Fensters darstellt. Sie kann auf einen Prozentsatz zwischen 10 und 400 festgelegt werden.

zoom: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

Details zur Methode

activate()

Aktiviert das Fenster.

activate(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

activateNext()

Aktiviert das nächste Fenster.

activateNext(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

activatePrevious()

Aktiviert das vorherige Fenster.

activatePrevious(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

close()

Schließt das Fenster.

close(): OfficeExtension.ClientResult<boolean>;

Gibt zurück

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

largeScroll(Down, Up, ToRight, ToLeft)

Führt einen Bildlauf im Fenster um mehrere Seiten durch. Die downParameter , up, toRightund toLeft entsprechen der Aktion des Bildlaufs mit den Tasten "Bild nach unten", "Bild oben", "ALT+BILD-AB" und "ALT+BILD-AUF" auf der Tastatur.

largeScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;

Parameter

Down

number

Up

number

ToRight

number

ToLeft

number

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.WindowLoadOptions): Excel.Window;

Parameter

options
Excel.Interfaces.WindowLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.Window;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Window;

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

newWindow()

Öffnet ein neues Excel-Fenster.

newWindow(): Excel.Window;

Gibt zurück

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

pointsToScreenPixelsX(Points)

Konvertiert horizontale Punkte in Bildschirmpixel.

pointsToScreenPixelsX(Points: number): OfficeExtension.ClientResult<number>;

Parameter

Points

number

Gibt zurück

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

pointsToScreenPixelsY(Points)

Konvertiert vertikale Punkte in Bildschirmpixel.

pointsToScreenPixelsY(Points: number): OfficeExtension.ClientResult<number>;

Parameter

Points

number

Gibt zurück

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

scrollIntoView(Left, Top, Width, Height, Start)

Führt einen Bildlauf im Fenster durch, um den angegebenen Bereich anzuzeigen.

scrollIntoView(Left: number, Top: number, Width: number, Height: number, Start?: boolean): void;

Parameter

Left

number

Top

number

Width

number

Height

number

Start

boolean

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

scrollWorkbookTabs(Sheets, Position)

Führt einen Bildlauf auf den Arbeitsmappenregistern durch.

scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition): void;

Parameter

Sheets

number

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

scrollWorkbookTabs(Sheets, Position)

Führt einen Bildlauf auf den Arbeitsmappenregistern durch.

scrollWorkbookTabs(Sheets?: number, Position?: "First" | "Last"): void;

Parameter

Sheets

number

Position

"First" | "Last"

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties
Excel.Interfaces.WindowUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.Window): void;

Parameter

properties
Excel.Window

Gibt zurück

void

smallScroll(Down, Up, ToRight, ToLeft)

Führt einen Bildlauf im Fenster um eine Reihe von Zeilen oder Spalten durch. Die downParameter , up, toRightund toLeft entsprechen der Aktion des Bildlaufs mit Pfeiltasten auf der Tastatur.

smallScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;

Parameter

Down

number

Up

number

ToRight

number

ToLeft

number

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Window Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.WindowData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.WindowData;

Gibt zurück