Word.Window class
Stellt das Fenster dar, in dem das Dokument angezeigt wird. Ein Fenster kann geteilt werden, um mehrere Lesebereiche zu enthalten.
- Extends
Hinweise
Verwendet von
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml
await Word.run(async (context) => {
// Gets the first paragraph of each page.
console.log("Getting first paragraph of each page...");
// Get the active window.
const activeWindow: Word.Window = context.document.activeWindow;
activeWindow.load();
// Get the active pane.
const activePane: Word.Pane = activeWindow.activePane;
activePane.load();
// Get all pages.
const pages: Word.PageCollection = activePane.pages;
pages.load();
await context.sync();
// Get page index and paragraphs of each page.
const pagesIndexes = [];
const pagesNumberOfParagraphs = [];
const pagesFirstParagraphText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
page.load("index");
pagesIndexes.push(page);
const paragraphs = page.getRange().paragraphs;
paragraphs.load("items/length");
pagesNumberOfParagraphs.push(paragraphs);
const firstParagraph = paragraphs.getFirst();
firstParagraph.load("text");
pagesFirstParagraphText.push(firstParagraph);
}
await context.sync();
for (let i = 0; i < pagesIndexes.length; i++) {
console.log(`Page index: ${pagesIndexes[i].index}`);
console.log(`Number of paragraphs: ${pagesNumberOfParagraphs[i].items.length}`);
console.log("First paragraph's text:", pagesFirstParagraphText[i].text);
}
});
Eigenschaften
| active |
Ruft den aktiven Bereich im Fenster ab. |
| are |
Gibt an, ob Lineale für das Fenster oder den Bereich angezeigt werden. |
| are |
Gibt an, ob Kommentare, Fußnoten, Endnoten und Links als Tipps angezeigt werden. |
| are |
Gibt an, ob Miniaturansichten der Seiten in einem Dokument auf der linken Seite des Microsoft Word-Dokumentfensters angezeigt werden. |
| caption | Gibt den Untertitel für das Fenster an, das in der Titelleiste des Dokuments oder Anwendungsfensters angezeigt wird. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| height | Gibt die Höhe des Fensters (in Punkt) an. |
| horizontal |
Gibt die horizontale Scrollposition als Prozentsatz der Dokumentbreite an. |
| ime |
Gibt den Standardstartmodus des Eingabemethoden-Editors (IME) für Japanisch an. |
| index | Ruft die Position eines Elements in einer Sammlung ab. |
| is |
Gibt an, ob das Fenster aktiv ist. |
| is |
Gibt an, ob die Dokumentstruktur sichtbar ist. |
| is |
Gibt an, ob der E-Mail-Nachrichtenkopf im Dokumentfenster sichtbar ist. Der Standardwert ist |
| is |
Gibt an, ob für das Fenster eine horizontale Bildlaufleiste angezeigt wird. |
| is |
Gibt an, ob die vertikale Bildlaufleiste auf der linken Seite des Dokumentfensters angezeigt wird. |
| is |
Gibt an, ob das vertikale Lineal in der Drucklayoutansicht auf der rechten Seite des Dokumentfensters angezeigt wird. |
| is |
Gibt an, ob das Fenster in mehrere Bereiche unterteilt ist. |
| is |
Gibt an, ob für das Fenster oder den Bereich ein vertikales Lineal angezeigt wird. |
| is |
Gibt an, ob für das Fenster eine vertikale Bildlaufleiste angezeigt wird. |
| is |
Gibt an, ob das Fenster sichtbar ist. |
| left | Gibt die horizontale Position des Fensters an, gemessen in Punkten. |
| next | Ruft das nächste Dokumentfenster in der Sammlung der geöffneten Dokumentfenster ab. |
| panes | Ruft die Sammlung der Bereiche im Fenster ab. |
| previous | Ruft das vorherige Dokumentfenster in den geöffneten Sammlungsdokumentfenstern ab. |
| show |
Gibt an, wie Microsoft Word Quelldokumente nach einem Vergleichs- und Seriendruckprozess anzeigt. |
| split |
Gibt den Prozentsatz der vertikalen Aufteilung für das Fenster an. |
| state | Gibt den Status des Dokumentfensters oder Aufgabenfensters an. |
| style |
Gibt die Breite der Formatvorlagenfläche in Punkt an. |
| top | Gibt die vertikale Position des Dokumentfensters in Punkt an. |
| type | Ruft den Fenstertyp ab. |
| usable |
Ruft die Höhe (in Punkt) des aktiven Arbeitsbereichs im Dokumentfenster ab. |
| usable |
Ruft die Breite (in Punkt) des aktiven Arbeitsbereichs im Dokumentfenster ab. |
| vertical |
Gibt die vertikale Scrollposition als Prozentsatz der Dokumentlänge an. |
| view | Ruft das |
| width | Gibt die Breite des Dokumentfensters in Punkt an. |
| window |
Ruft eine Ganzzahl ab, die die Position des Fensters darstellt. |
Methoden
| activate() | Aktiviert das Fenster. |
| close(options) | Schließt das Fenster. |
| large |
Scrollt das Fenster um die angegebene Anzahl von Bildschirmen. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| page |
Scrollt seitenweise durch das Fenster. |
| 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. |
| set |
Setzt den Fokus des Dokumentfensters auf den Textkörper einer E-Mail-Nachricht. |
| small |
Scrollt das Fenster um die angegebene Anzahl von Zeilen. Eine "Linie" entspricht der Entfernung, die durch einmaliges Klicken auf den Bildlaufpfeil auf der Bildlaufleiste gescrollt wird. |
| toggle |
Blendet das Menüband ein bzw. aus. |
| toJSON() | Überschreibt die JavaScript-Methode |
| track() | Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt aufrufübergreifend |
| untrack() | Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen einen Aufruf durchführen |
Details zur Eigenschaft
activePane
Ruft den aktiven Bereich im Fenster ab.
readonly activePane: Word.Pane;Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml
await Word.run(async (context) => {
// Gets the pages enclosing the viewport.
// Get the active window.
const activeWindow: Word.Window = context.document.activeWindow;
activeWindow.load();
// Get the active pane.
const activePane: Word.Pane = activeWindow.activePane;
activePane.load();
// Get pages enclosing the viewport.
const pages: Word.PageCollection = activePane.pagesEnclosingViewport;
pages.load();
await context.sync();
// Log the number of pages.
const pageCount = pages.items.length;
console.log(`Number of pages enclosing the viewport: ${pageCount}`);
// Log index info of these pages.
const pagesIndexes = [];
for (let i = 0; i < pageCount; i++) {
const page = pages.items[i];
page.load("index");
pagesIndexes.push(page);
}
await context.sync();
for (let i = 0; i < pagesIndexes.length; i++) {
console.log(`Page index: ${pagesIndexes[i].index}`);
}
});
areRulersDisplayed
Gibt an, ob Lineale für das Fenster oder den Bereich angezeigt werden.
areRulersDisplayed: boolean;Eigenschaftswert
boolean
Hinweise
areScreenTipsDisplayed
Gibt an, ob Kommentare, Fußnoten, Endnoten und Links als Tipps angezeigt werden.
readonly areScreenTipsDisplayed: boolean;Eigenschaftswert
boolean
Hinweise
areThumbnailsDisplayed
Gibt an, ob Miniaturansichten der Seiten in einem Dokument auf der linken Seite des Microsoft Word-Dokumentfensters angezeigt werden.
areThumbnailsDisplayed: boolean;Eigenschaftswert
boolean
Hinweise
caption
Gibt den Untertitel für das Fenster an, das in der Titelleiste des Dokuments oder Anwendungsfensters angezeigt wird.
caption: string;Eigenschaftswert
string
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
height
Gibt die Höhe des Fensters (in Punkt) an.
readonly height: number;Eigenschaftswert
number
Hinweise
horizontalPercentScrolled
Gibt die horizontale Scrollposition als Prozentsatz der Dokumentbreite an.
horizontalPercentScrolled: number;Eigenschaftswert
number
Hinweise
imeMode
Gibt den Standardstartmodus des Eingabemethoden-Editors (IME) für Japanisch an.
imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul";Eigenschaftswert
Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"
Hinweise
index
Ruft die Position eines Elements in einer Sammlung ab.
readonly index: number;Eigenschaftswert
number
Hinweise
isActive
Gibt an, ob das Fenster aktiv ist.
readonly isActive: boolean;Eigenschaftswert
boolean
Hinweise
isDocumentMapVisible
Gibt an, ob die Dokumentstruktur sichtbar ist.
isDocumentMapVisible: boolean;Eigenschaftswert
boolean
Hinweise
isEnvelopeVisible
Gibt an, ob der E-Mail-Nachrichtenkopf im Dokumentfenster sichtbar ist. Der Standardwert ist false.
isEnvelopeVisible: boolean;Eigenschaftswert
boolean
Hinweise
isHorizontalScrollBarDisplayed
Gibt an, ob für das Fenster eine horizontale Bildlaufleiste angezeigt wird.
isHorizontalScrollBarDisplayed: boolean;Eigenschaftswert
boolean
Hinweise
isLeftScrollBarDisplayed
Gibt an, ob die vertikale Bildlaufleiste auf der linken Seite des Dokumentfensters angezeigt wird.
isLeftScrollBarDisplayed: boolean;Eigenschaftswert
boolean
Hinweise
isRightRulerDisplayed
Gibt an, ob das vertikale Lineal in der Drucklayoutansicht auf der rechten Seite des Dokumentfensters angezeigt wird.
isRightRulerDisplayed: boolean;Eigenschaftswert
boolean
Hinweise
isSplit
Gibt an, ob das Fenster in mehrere Bereiche unterteilt ist.
isSplit: boolean;Eigenschaftswert
boolean
Hinweise
isVerticalRulerDisplayed
Gibt an, ob für das Fenster oder den Bereich ein vertikales Lineal angezeigt wird.
isVerticalRulerDisplayed: boolean;Eigenschaftswert
boolean
Hinweise
isVerticalScrollBarDisplayed
Gibt an, ob für das Fenster eine vertikale Bildlaufleiste angezeigt wird.
isVerticalScrollBarDisplayed: boolean;Eigenschaftswert
boolean
Hinweise
isVisible
Gibt an, ob das Fenster sichtbar ist.
isVisible: boolean;Eigenschaftswert
boolean
Hinweise
left
Gibt die horizontale Position des Fensters an, gemessen in Punkten.
readonly left: number;Eigenschaftswert
number
Hinweise
next
Ruft das nächste Dokumentfenster in der Sammlung der geöffneten Dokumentfenster ab.
readonly next: Word.Window;Eigenschaftswert
Hinweise
panes
Ruft die Sammlung der Bereiche im Fenster ab.
readonly panes: Word.PaneCollection;Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml
await Word.run(async (context) => {
// Gets all the panes in the active document window.
// Get the active window.
const activeWindow: Word.Window = context.document.activeWindow;
activeWindow.load("panes/items/length");
await context.sync();
const panes: Word.PaneCollection = activeWindow.panes;
console.log(`Number of panes in the current document window: ${panes.items.length}`);
});
previous
Ruft das vorherige Dokumentfenster in den geöffneten Sammlungsdokumentfenstern ab.
readonly previous: Word.Window;Eigenschaftswert
Hinweise
showSourceDocuments
Gibt an, wie Microsoft Word Quelldokumente nach einem Vergleichs- und Seriendruckprozess anzeigt.
showSourceDocuments: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both";Eigenschaftswert
Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"
Hinweise
splitVertical
Gibt den Prozentsatz der vertikalen Aufteilung für das Fenster an.
splitVertical: number;Eigenschaftswert
number
Hinweise
state
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.
Gibt den Status des Dokumentfensters oder Aufgabenfensters an.
state: Word.WindowState | "Normal" | "Maximize" | "Minimize";Eigenschaftswert
Word.WindowState | "Normal" | "Maximize" | "Minimize"
Hinweise
styleAreaWidth
Gibt die Breite der Formatvorlagenfläche in Punkt an.
styleAreaWidth: number;Eigenschaftswert
number
Hinweise
top
Gibt die vertikale Position des Dokumentfensters in Punkt an.
readonly top: number;Eigenschaftswert
number
Hinweise
type
Ruft den Fenstertyp ab.
readonly type: Word.WindowType | "Document" | "Template";Eigenschaftswert
Word.WindowType | "Document" | "Template"
Hinweise
usableHeight
Ruft die Höhe (in Punkt) des aktiven Arbeitsbereichs im Dokumentfenster ab.
readonly usableHeight: number;Eigenschaftswert
number
Hinweise
usableWidth
Ruft die Breite (in Punkt) des aktiven Arbeitsbereichs im Dokumentfenster ab.
readonly usableWidth: number;Eigenschaftswert
number
Hinweise
verticalPercentScrolled
Gibt die vertikale Scrollposition als Prozentsatz der Dokumentlänge an.
verticalPercentScrolled: number;Eigenschaftswert
number
Hinweise
view
Ruft das View Objekt ab, das die Ansicht für das Fenster darstellt.
readonly view: Word.View;Eigenschaftswert
Hinweise
width
Gibt die Breite des Dokumentfensters in Punkt an.
readonly width: number;Eigenschaftswert
number
Hinweise
windowNumber
Ruft eine Ganzzahl ab, die die Position des Fensters darstellt.
readonly windowNumber: number;Eigenschaftswert
number
Hinweise
Details zur Methode
activate()
close(options)
Schließt das Fenster.
close(options?: Word.WindowCloseOptions): void;Parameter
- options
- Word.WindowCloseOptions
Optional. Die Optionen, mit denen definiert wird, ob Änderungen vor dem Schließen gespeichert und das Dokument weitergeleitet werden soll.
Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/close-document-window.yaml
await Word.run(async (context) => {
// Closes the document window, prompting to save if this is a new document.
const window: Word.Window = context.document.activeWindow;
const closeOptions: Word.WindowCloseOptions = { saveChanges: Word.SaveConfiguration.promptToSaveChanges };
console.log("About to close the document window...");
window.close(closeOptions);
});
largeScroll(options)
Scrollt das Fenster um die angegebene Anzahl von Bildschirmen.
largeScroll(options?: Word.WindowScrollOptions): void;Parameter
- options
- Word.WindowScrollOptions
Optional. Die Optionen zum Scrollen des Fensters um die angegebene Anzahl von Bildschirmen. Wenn keine Optionen angegeben sind, wird das Fenster um einen Bildschirm nach unten gescrollt.
Gibt zurück
void
Hinweise
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?: Word.Interfaces.WindowLoadOptions): Word.Window;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
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[]): Word.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;
}): Word.Window;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
pageScroll(options)
Scrollt seitenweise durch das Fenster.
pageScroll(options?: Word.WindowPageScrollOptions): void;Parameter
- options
- Word.WindowPageScrollOptions
Optional. Die Optionen zum Scrollen durch das Fenster Seite für Seite.
Gibt zurück
void
Hinweise
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
- Word.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
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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: Word.Window): void;Parameter
- properties
- Word.Window
Gibt zurück
void
setFocus()
Setzt den Fokus des Dokumentfensters auf den Textkörper einer E-Mail-Nachricht.
setFocus(): void;Gibt zurück
void
Hinweise
smallScroll(options)
Scrollt das Fenster um die angegebene Anzahl von Zeilen. Eine "Linie" entspricht der Entfernung, die durch einmaliges Klicken auf den Bildlaufpfeil auf der Bildlaufleiste gescrollt wird.
smallScroll(options?: Word.WindowScrollOptions): void;Parameter
- options
- Word.WindowScrollOptions
Optional. Die Optionen zum Scrollen des Fensters um die angegebene Anzahl von Zeilen. Wenn keine Optionen angegeben sind, wird das Fenster um eine Zeile nach unten gescrollt.
Gibt zurück
void
Hinweise
toggleRibbon()
Blendet das Menüband ein bzw. aus.
toggleRibbon(): void;Gibt zurück
void
Hinweise
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 sie übergeben wird.) Während das ursprüngliche Word.Window Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.WindowData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Word.Interfaces.WindowData;Gibt zurück
track()
Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt aufrufübergreifend .sync und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.
track(): Word.Window;Gibt zurück
untrack()
Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.Window;