Word.Window class

Paket:: word

Stellt das Fenster dar, in dem das Dokument angezeigt wird. Ein Fenster kann aufgeteilt werden, um mehrere Lesebereiche zu enthalten.

Extends: OfficeExtension.ClientObject

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

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

activePane	Ruft den aktiven Bereich im Fenster ab.
areRulersDisplayed	Gibt an, ob Lineale für das Fenster oder den Bereich angezeigt werden.
areScreenTipsDisplayed	Gibt an, ob Kommentare, Fußnoten, Endnoten und Hyperlinks als Tipps angezeigt werden.
areThumbnailsDisplayed	Gibt an, ob Miniaturansichten der Seiten in einem Dokument auf der linken Seite des Microsoft Word-Dokumentfensters angezeigt werden.
caption	Gibt den Untertitel Text für das Fenster an, das in der Titelleiste des Dokument- oder Anwendungsfensters angezeigt wird.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
height	Gibt die Höhe des Fensters (in Punkt) an.
horizontalPercentScrolled	Gibt die horizontale Bildlaufposition als Prozentsatz der Dokumentbreite an.
imeMode	Gibt den Standardstartmodus des Eingabemethoden-Editors (IME) für Japanisch an.
index	Ruft die Position eines Elements in einer Auflistung ab.
isActive	Gibt an, ob das Fenster aktiv ist.
isDocumentMapVisible	Gibt an, ob die Dokumentzuordnung sichtbar ist.
isEnvelopeVisible	Gibt an, ob der Header der E-Mail-Nachricht im Dokumentfenster angezeigt wird. Der Standardwert ist `false`.
isHorizontalScrollBarDisplayed	Gibt an, ob eine horizontale Bildlaufleiste für das Fenster angezeigt wird.
isLeftScrollBarDisplayed	Gibt an, ob die vertikale Bildlaufleiste auf der linken Seite des Dokumentfensters angezeigt wird.
isRightRulerDisplayed	Gibt an, ob das vertikale Lineal auf der rechten Seite des Dokumentfensters in der Drucklayoutansicht angezeigt wird.
isSplit	Gibt an, ob das Fenster in mehrere Bereiche unterteilt ist.
isVerticalRulerDisplayed	Gibt an, ob ein vertikales Lineal für das Fenster oder den Bereich angezeigt wird.
isVerticalScrollBarDisplayed	Gibt an, ob eine vertikale Bildlaufleiste für das Fenster angezeigt wird.
isVisible	Gibt an, ob das Fenster sichtbar ist.
left	Gibt die horizontale Position des Fensters in Punkt an.
next	Ruft das nächste Dokumentfenster in der Auflistung geöffneter Dokumentfenster ab.
panes	Ruft die Auflistung der Bereiche im Fenster ab.
previous	Ruft das vorherige Dokumentfenster in den geöffneten Dokumentfenstern der Auflistung ab.
showSourceDocuments	Gibt an, wie Microsoft Word Quelldokumente nach einem Vergleichs- und Zusammenführungsprozess anzeigt.
splitVertical	Gibt den Prozentsatz der vertikalen Aufteilung für das Fenster an.
state	Gibt den Zustand des Dokument- oder Aufgabenfensters an.
styleAreaWidth	Gibt die Breite des Stilbereichs in Punkt an.
top	Gibt die vertikale Position des Dokumentfensters in Punkt an.
type	Ruft den Fenstertyp ab.
usableHeight	Ruft die Höhe (in Punkt) des aktiven Arbeitsbereichs im Dokumentfenster ab.
usableWidth	Ruft die Breite (in Punkt) des aktiven Arbeitsbereichs im Dokumentfenster ab.
verticalPercentScrolled	Gibt die vertikale Bildlaufposition als Prozentsatz der Dokumentlänge an.
view	Ruft das `View` -Objekt ab, das die Ansicht für das Fenster darstellt.
width	Gibt die Breite des Dokumentfensters in Punkt an.
windowNumber	Ruft eine ganze Zahl ab, die die Position des Fensters darstellt.

Methoden

activate()	Aktiviert das Fenster.
close(options)	Schließt das Fenster.
largeScroll(options)	Führt einen Bildlauf im Fenster um die angegebene Anzahl von Bildschirmen durch.
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.
pageScroll(options)	Scrollt seite für Seite 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.
setFocus()	Legt den Fokus des Dokumentfensters auf den Text einer E-Mail-Nachricht fest.
smallScroll(options)	Führt einen Bildlauf im Fenster um die angegebene Anzahl von Zeilen durch. Eine "Linie" entspricht der Entfernung, die durch einmaliges Klicken auf den Bildlaufpfeil auf der Bildlaufleiste gescrollt wird.
toggleRibbon()	Blendet das Menüband ein bzw. aus.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche `Word.Window` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (typisiert als `Word.Interfaces.WindowData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
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 über `.sync` Aufrufe hinweg 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 den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
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 aufrufen `context.sync()` , bevor die Speicherfreigabe wirksam wird.

Details zur Eigenschaft

activePane

Ruft den aktiven Bereich im Fenster ab.

readonly activePane: Word.Pane;

Eigenschaftswert

Word.Pane

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

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

[ API-Satz: WordApiDesktop 1.4 ]

areScreenTipsDisplayed

Gibt an, ob Kommentare, Fußnoten, Endnoten und Hyperlinks als Tipps angezeigt werden.

readonly areScreenTipsDisplayed: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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

[ API-Satz: WordApiDesktop 1.4 ]

caption

Gibt den Untertitel Text für das Fenster an, das in der Titelleiste des Dokument- oder Anwendungsfensters angezeigt wird.

caption: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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

Word.RequestContext

height

Gibt die Höhe des Fensters (in Punkt) an.

readonly height: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

horizontalPercentScrolled

Gibt die horizontale Bildlaufposition als Prozentsatz der Dokumentbreite an.

horizontalPercentScrolled: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

index

Ruft die Position eines Elements in einer Auflistung ab.

readonly index: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

isActive

Gibt an, ob das Fenster aktiv ist.

readonly isActive: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

isDocumentMapVisible

Gibt an, ob die Dokumentzuordnung sichtbar ist.

isDocumentMapVisible: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

isEnvelopeVisible

Gibt an, ob der Header der E-Mail-Nachricht im Dokumentfenster angezeigt wird. Der Standardwert ist false.

isEnvelopeVisible: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

isHorizontalScrollBarDisplayed

Gibt an, ob eine horizontale Bildlaufleiste für das Fenster angezeigt wird.

isHorizontalScrollBarDisplayed: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

isLeftScrollBarDisplayed

Gibt an, ob die vertikale Bildlaufleiste auf der linken Seite des Dokumentfensters angezeigt wird.

isLeftScrollBarDisplayed: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

isRightRulerDisplayed

Gibt an, ob das vertikale Lineal auf der rechten Seite des Dokumentfensters in der Drucklayoutansicht angezeigt wird.

isRightRulerDisplayed: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

isSplit

Gibt an, ob das Fenster in mehrere Bereiche unterteilt ist.

isSplit: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

isVerticalRulerDisplayed

Gibt an, ob ein vertikales Lineal für das Fenster oder den Bereich angezeigt wird.

isVerticalRulerDisplayed: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

isVerticalScrollBarDisplayed

Gibt an, ob eine vertikale Bildlaufleiste für das Fenster angezeigt wird.

isVerticalScrollBarDisplayed: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

isVisible

Gibt an, ob das Fenster sichtbar ist.

isVisible: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

left

Gibt die horizontale Position des Fensters in Punkt an.

readonly left: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Ruft das nächste Dokumentfenster in der Auflistung geöffneter Dokumentfenster ab.

readonly next: Word.Window;

Eigenschaftswert

Word.Window

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

panes

Ruft die Auflistung der Bereiche im Fenster ab.

readonly panes: Word.PaneCollection;

Eigenschaftswert

Word.PaneCollection

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

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}`);
});

Ruft das vorherige Dokumentfenster in den geöffneten Dokumentfenstern der Auflistung ab.

readonly previous: Word.Window;

Eigenschaftswert

Word.Window

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

showSourceDocuments

Gibt an, wie Microsoft Word Quelldokumente nach einem Vergleichs- und Zusammenführungsprozess anzeigt.

showSourceDocuments: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both";

Eigenschaftswert

Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

splitVertical

Gibt den Prozentsatz der vertikalen Aufteilung für das Fenster an.

splitVertical: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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 Zustand des Dokument- oder Aufgabenfensters an.

state: Word.WindowState | "Normal" | "Maximize" | "Minimize";

Eigenschaftswert

Word.WindowState | "Normal" | "Maximize" | "Minimize"

Hinweise

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

styleAreaWidth

Gibt die Breite des Stilbereichs in Punkt an.

styleAreaWidth: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

top

Gibt die vertikale Position des Dokumentfensters in Punkt an.

readonly top: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

type

Ruft den Fenstertyp ab.

readonly type: Word.WindowType | "Document" | "Template";

Eigenschaftswert

Word.WindowType | "Document" | "Template"

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

usableHeight

Ruft die Höhe (in Punkt) des aktiven Arbeitsbereichs im Dokumentfenster ab.

readonly usableHeight: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

usableWidth

Ruft die Breite (in Punkt) des aktiven Arbeitsbereichs im Dokumentfenster ab.

readonly usableWidth: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

verticalPercentScrolled

Gibt die vertikale Bildlaufposition als Prozentsatz der Dokumentlänge an.

verticalPercentScrolled: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

view

Ruft das View -Objekt ab, das die Ansicht für das Fenster darstellt.

readonly view: Word.View;

Eigenschaftswert

Word.View

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

width

Gibt die Breite des Dokumentfensters in Punkt an.

readonly width: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

windowNumber

Ruft eine ganze Zahl ab, die die Position des Fensters darstellt.

readonly windowNumber: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Details zur Methode

activate()

Aktiviert das Fenster.

activate(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

close(options)

Schließt das Fenster.

close(options?: Word.WindowCloseOptions): void;

Parameter

options: Word.WindowCloseOptions

Optional. Die Optionen, die definieren, ob Änderungen vor dem Schließen gespeichert werden sollen und ob das Dokument weitergeleitet werden soll.

Gibt zurück

void

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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)

Führt einen Bildlauf im Fenster um die angegebene Anzahl von Bildschirmen durch.

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

[ API-Satz: WordApiDesktop 1.4 ]

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

options: Word.Interfaces.WindowLoadOptions

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

Gibt zurück

Word.Window

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

Word.Window

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 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

Word.Window

pageScroll(options)

Scrollt seite für Seite durch das Fenster.

pageScroll(options?: Word.WindowPageScrollOptions): void;

Parameter

options: Word.WindowPageScrollOptions

Optional. Die Optionen für den seitenseitigen Bildlauf durch das Fenster.

Gibt zurück

void

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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

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: Word.Window): void;

Parameter

properties: Word.Window

Gibt zurück

void

setFocus()

Legt den Fokus des Dokumentfensters auf den Text einer E-Mail-Nachricht fest.

setFocus(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

smallScroll(options)

Führt einen Bildlauf im Fenster um die angegebene Anzahl von Zeilen durch. 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

[ API-Satz: WordApiDesktop 1.4 ]

toggleRibbon()

Blendet das Menüband ein bzw. aus.

toggleRibbon(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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 Word.Window Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.WindowData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.WindowData;

Gibt zurück

Word.Interfaces.WindowData

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 über .sync Aufrufe hinweg 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 den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.

track(): Word.Window;

Gibt zurück

Word.Window

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 aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.Window;

Gibt zurück

Word.Window

Feedback

War diese Seite hilfreich?

Freigeben über

Word.Window class

Hinweise

Beispiele

Eigenschaften

Methoden

Details zur Eigenschaft

activePane

Eigenschaftswert

Hinweise

Beispiele

areRulersDisplayed

Eigenschaftswert

Hinweise

areScreenTipsDisplayed

Eigenschaftswert

Hinweise

areThumbnailsDisplayed

Eigenschaftswert

Hinweise

caption

Eigenschaftswert

Hinweise

context

Eigenschaftswert

height

Eigenschaftswert

Hinweise

horizontalPercentScrolled

Eigenschaftswert

Hinweise

imeMode

Eigenschaftswert

Hinweise

index

Eigenschaftswert

Hinweise

isActive

Eigenschaftswert

Hinweise

isDocumentMapVisible

Eigenschaftswert

Hinweise

isEnvelopeVisible

Eigenschaftswert

Hinweise

isHorizontalScrollBarDisplayed

Eigenschaftswert

Hinweise

isLeftScrollBarDisplayed

Eigenschaftswert

Hinweise

isRightRulerDisplayed

Eigenschaftswert

Hinweise

isSplit

Eigenschaftswert

Hinweise

isVerticalRulerDisplayed

Eigenschaftswert

Hinweise

isVerticalScrollBarDisplayed

Eigenschaftswert

Hinweise

isVisible

Eigenschaftswert

Hinweise

left

Eigenschaftswert

Hinweise

next

Eigenschaftswert

Hinweise

panes

Eigenschaftswert

Hinweise

Beispiele

previous

Eigenschaftswert

Hinweise