Word.Window class

Représente la fenêtre qui affiche le document. Une fenêtre peut être fractionnée pour contenir plusieurs volets de lecture.

Extends

Remarques

Jeu d’API : WordApiDesktop 1.2

Utilisateur

Exemples

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

Propriétés

activePane

Obtient le volet actif dans la fenêtre.

areRulersDisplayed

Spécifie si les règles sont affichées pour la fenêtre ou le volet.

areScreenTipsDisplayed

Indique si les commentaires, les notes de bas de page, les notes de fin et les liens hypertexte sont affichés en tant qu’astuces.

areThumbnailsDisplayed

Indique si les images miniatures des pages d’un document sont affichées le long du côté gauche de la fenêtre du document Microsoft Word.

caption

Indique le texte de la légende de la fenêtre qui s’affiche dans la barre de titre du document ou de la fenêtre d’application.

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

height

Spécifie la hauteur de la fenêtre (en points).

horizontalPercentScrolled

Spécifie la position de défilement horizontale en pourcentage de la largeur du document.

imeMode

Définit le mode de démarrage par défaut de l'éditeur de méthode d'entrée (IME) du japonais.

index

Obtient la position d’un élément dans une collection.

isActive

Indique si la fenêtre est active.

isDocumentMapVisible

Indique si l’espace de document est visible.

isEnvelopeVisible

Indique si l’en-tête de l’e-mail est visible dans la fenêtre du document. La valeur par défaut est false.

isHorizontalScrollBarDisplayed

Indique si une barre de défilement horizontale est affichée pour la fenêtre.

isLeftScrollBarDisplayed

Indique si la barre de défilement verticale s’affiche sur le côté gauche de la fenêtre du document.

isRightRulerDisplayed

Indique si la règle verticale apparaît sur le côté droit de la fenêtre du document en mode Page.

isSplit

Indique si la fenêtre est fractionnée en plusieurs volets.

isVerticalRulerDisplayed

Spécifie si une règle verticale est affichée pour la fenêtre ou le volet.

isVerticalScrollBarDisplayed

Indique si une barre de défilement verticale est affichée pour la fenêtre.

isVisible

Indique si la fenêtre est visible.

left

Spécifie la position horizontale de la fenêtre, mesurée en points.

next

Obtient la fenêtre de document suivante dans la collection de fenêtres de document ouvertes.

panes

Obtient l’ensemble des volets de la fenêtre.

previous

Récupère la fenêtre de document précédente dans la collection, ouvre les fenêtres de document.

showSourceDocuments

Spécifie la manière dont Microsoft Word affiche les documents sources après un processus de comparaison et de fusion.

splitVertical

Spécifie le pourcentage de fractionnement vertical de la fenêtre.

state

Spécifie l’état de la fenêtre du document ou de la fenêtre des tâches.

styleAreaWidth

Spécifie la largeur de la zone de style en points.

top

Spécifie la position verticale de la fenêtre du document, en points.

type

Récupère le type de fenêtre.

usableHeight

Obtient la hauteur (en points) de la zone de travail active dans la fenêtre du document.

usableWidth

Obtient la largeur (en points) de la zone de travail active dans la fenêtre du document.

verticalPercentScrolled

Spécifie la position de défilement vertical sous forme de pourcentage de la longueur du document.

view

Obtient l’objet View qui représente la vue de la fenêtre.

width

Spécifie la largeur de la fenêtre du document, en points.

windowNumber

Obtient un nombre entier qui représente la position de la fenêtre.

Méthodes

activate()

Active la fenêtre.

close(options)

Ferme la fenêtre.

largeScroll(options)

Fait défiler la fenêtre du nombre d’écrans spécifié.

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

pageScroll(options)

Fait défiler la fenêtre page par page.

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

setFocus()

Définit le focus de la fenêtre de document sur le corps d’un courrier électronique.

smallScroll(options)

Fait défiler la fenêtre du nombre de lignes spécifié. Une « ligne » correspond à la distance parcourue en cliquant une fois sur la flèche de défilement de la barre de défilement.

toggleRibbon()

Affiche ou masque le ruban.

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.Window est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.WindowDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

Détails de la propriété

activePane

Obtient le volet actif dans la fenêtre.

readonly activePane: Word.Pane;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

Spécifie si les règles sont affichées pour la fenêtre ou le volet.

areRulersDisplayed: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

areScreenTipsDisplayed

Indique si les commentaires, les notes de bas de page, les notes de fin et les liens hypertexte sont affichés en tant qu’astuces.

readonly areScreenTipsDisplayed: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

areThumbnailsDisplayed

Indique si les images miniatures des pages d’un document sont affichées le long du côté gauche de la fenêtre du document Microsoft Word.

areThumbnailsDisplayed: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

caption

Indique le texte de la légende de la fenêtre qui s’affiche dans la barre de titre du document ou de la fenêtre d’application.

caption: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApiDesktop 1.4

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

height

Spécifie la hauteur de la fenêtre (en points).

readonly height: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

horizontalPercentScrolled

Spécifie la position de défilement horizontale en pourcentage de la largeur du document.

horizontalPercentScrolled: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

imeMode

Définit le mode de démarrage par défaut de l'éditeur de méthode d'entrée (IME) du japonais.

imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul";

Valeur de propriété

Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"

Remarques

Jeu d’API : WordApiDesktop 1.4

index

Obtient la position d’un élément dans une collection.

readonly index: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

isActive

Indique si la fenêtre est active.

readonly isActive: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

isDocumentMapVisible

Indique si l’espace de document est visible.

isDocumentMapVisible: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

isEnvelopeVisible

Indique si l’en-tête de l’e-mail est visible dans la fenêtre du document. La valeur par défaut est false.

isEnvelopeVisible: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

isHorizontalScrollBarDisplayed

Indique si une barre de défilement horizontale est affichée pour la fenêtre.

isHorizontalScrollBarDisplayed: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

isLeftScrollBarDisplayed

Indique si la barre de défilement verticale s’affiche sur le côté gauche de la fenêtre du document.

isLeftScrollBarDisplayed: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

isRightRulerDisplayed

Indique si la règle verticale apparaît sur le côté droit de la fenêtre du document en mode Page.

isRightRulerDisplayed: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

isSplit

Indique si la fenêtre est fractionnée en plusieurs volets.

isSplit: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

isVerticalRulerDisplayed

Spécifie si une règle verticale est affichée pour la fenêtre ou le volet.

isVerticalRulerDisplayed: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

isVerticalScrollBarDisplayed

Indique si une barre de défilement verticale est affichée pour la fenêtre.

isVerticalScrollBarDisplayed: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

isVisible

Indique si la fenêtre est visible.

isVisible: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.4

left

Spécifie la position horizontale de la fenêtre, mesurée en points.

readonly left: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

next

Obtient la fenêtre de document suivante dans la collection de fenêtres de document ouvertes.

readonly next: Word.Window;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

panes

Obtient l’ensemble des volets de la fenêtre.

readonly panes: Word.PaneCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

Récupère la fenêtre de document précédente dans la collection, ouvre les fenêtres de document.

readonly previous: Word.Window;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

showSourceDocuments

Spécifie la manière dont Microsoft Word affiche les documents sources après un processus de comparaison et de fusion.

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

Valeur de propriété

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

Remarques

Jeu d’API : WordApiDesktop 1.4

splitVertical

Spécifie le pourcentage de fractionnement vertical de la fenêtre.

splitVertical: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

state

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie l’état de la fenêtre du document ou de la fenêtre des tâches.

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

Valeur de propriété

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

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

styleAreaWidth

Spécifie la largeur de la zone de style en points.

styleAreaWidth: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

top

Spécifie la position verticale de la fenêtre du document, en points.

readonly top: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

type

Récupère le type de fenêtre.

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

Valeur de propriété

Word.WindowType | "Document" | "Template"

Remarques

Jeu d’API : WordApiDesktop 1.4

usableHeight

Obtient la hauteur (en points) de la zone de travail active dans la fenêtre du document.

readonly usableHeight: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

usableWidth

Obtient la largeur (en points) de la zone de travail active dans la fenêtre du document.

readonly usableWidth: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

verticalPercentScrolled

Spécifie la position de défilement vertical sous forme de pourcentage de la longueur du document.

verticalPercentScrolled: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

view

Obtient l’objet View qui représente la vue de la fenêtre.

readonly view: Word.View;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

width

Spécifie la largeur de la fenêtre du document, en points.

readonly width: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

windowNumber

Obtient un nombre entier qui représente la position de la fenêtre.

readonly windowNumber: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

Détails de la méthode

activate()

Active la fenêtre.

activate(): void;

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

close(options)

Ferme la fenêtre.

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

Paramètres

options
Word.WindowCloseOptions

Facultatif. Les options qui définissent s’il faut enregistrer les modifications avant la fermeture et s’il faut acheminer le document.

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

Exemples

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

Fait défiler la fenêtre du nombre d’écrans spécifié.

largeScroll(options?: Word.WindowScrollOptions): void;

Paramètres

options
Word.WindowScrollOptions

Facultatif. Les options permettant de faire défiler la fenêtre du nombre d’écrans spécifié. Si aucune option n’est spécifiée, la fenêtre défile d’un écran vers le bas.

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

options
Word.Interfaces.WindowLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNamesAndPaths

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

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

pageScroll(options)

Fait défiler la fenêtre page par page.

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

Paramètres

options
Word.WindowPageScrollOptions

Facultatif. Les options de défilement dans la fenêtre page par page.

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

properties
Word.Interfaces.WindowUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.Window): void;

Paramètres

properties
Word.Window

Retours

void

setFocus()

Définit le focus de la fenêtre de document sur le corps d’un courrier électronique.

setFocus(): void;

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

smallScroll(options)

Fait défiler la fenêtre du nombre de lignes spécifié. Une « ligne » correspond à la distance parcourue en cliquant une fois sur la flèche de défilement de la barre de défilement.

smallScroll(options?: Word.WindowScrollOptions): void;

Paramètres

options
Word.WindowScrollOptions

Facultatif. Les options permettant de faire défiler la fenêtre du nombre de lignes spécifié. Si aucune option n’est spécifiée, la fenêtre défile d’une ligne vers le bas.

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

toggleRibbon()

Affiche ou masque le ruban.

toggleRibbon(): void;

Retours

void

Remarques

Jeu d’API : WordApiDesktop 1.4

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.Window est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.WindowDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.WindowData;

Retours

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.Window;

Retours

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

untrack(): Word.Window;

Retours