Partager via


Excel.Window class

Représente une fenêtre dans le classeur.

Extends

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

Propriétés

activeCell

Spécifie la cellule active dans la fenêtre.

activePane

Spécifie le volet actif dans la fenêtre.

activeWorksheet

Spécifie la feuille active dans la fenêtre.

autoFilterDateGroupingEnabled

Spécifie si le regroupement de dates de filtre automatique est activé dans la fenêtre.

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

enableResize

Spécifie si le redimensionnement est activé pour la fenêtre.

freezePanes

Spécifie si les volets sont figés dans la fenêtre.

height

Spécifie la hauteur de la fenêtre.

index

Obtient l’index de la fenêtre.

isVisible

Spécifie si la fenêtre est visible.

left

Spécifie la distance, en points, entre le bord gauche de l’écran de l’ordinateur et le bord gauche de la fenêtre.

name

Spécifie le nom de la fenêtre.

panes

Obtient une collection de volets associés à la fenêtre.

rangeSelection

Obtient la sélection de plage dans la fenêtre.

scrollColumn

Spécifie la colonne de défilement de la fenêtre.

scrollRow

Spécifie la ligne de défilement de la fenêtre.

showFormulas

Spécifie si les formules sont affichées dans la fenêtre.

showGridlines

Spécifie si le quadrillage est affiché dans la fenêtre.

showHeadings

Spécifie si les titres sont affichés dans la fenêtre.

showHorizontalScrollBar

Spécifie si la barre de défilement horizontale s’affiche dans la fenêtre.

showOutline

Spécifie si le plan est affiché dans la fenêtre.

showRightToLeft

Obtient la valeur de disposition de droite à gauche de la fenêtre. True signifie que la fenêtre utilise la disposition de droite à gauche, false signifie que la fenêtre utilise la disposition de gauche à droite.

showRuler

Spécifie si la règle est affichée dans la fenêtre.

showVerticalScrollBar

Spécifie si la barre de défilement verticale s’affiche dans la fenêtre.

showWhitespace

Spécifie si l’espace blanc est affiché dans la fenêtre.

showWorkbookTabs

Spécifie si les onglets du classeur sont affichés dans la fenêtre.

showZeros

Spécifie si les zéros sont affichés dans la fenêtre.

split

Spécifie l’état de fractionnement de la fenêtre.

splitColumn

Spécifie la colonne fractionnée de la fenêtre.

splitHorizontal

Spécifie le fractionnement horizontal de la fenêtre.

splitRow

Spécifie la ligne fractionnée de la fenêtre.

splitVertical

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

tabRatio

Spécifie le rapport de tabulation de la fenêtre.

top

Spécifie la distance, en points, entre le bord supérieur de la fenêtre et le bord supérieur de la zone utilisable (sous les menus, les barres d’outils ancrées en haut et la barre de formule).

type

Spécifie le type de la fenêtre.

usableHeight

Spécifie la hauteur utilisable de la fenêtre.

usableWidth

Spécifie la largeur utilisable de la fenêtre.

view

Spécifie la vue de la fenêtre.

visibleRange

Obtient la plage visible de la fenêtre.

width

Spécifie la largeur d’affichage de la fenêtre.

windowNumber

Obtient le numéro de la fenêtre.

windowState

Spécifie l’état de la fenêtre.

zoom

Spécifie une valeur entière qui représente la taille d’affichage de la fenêtre. Il peut être défini sur un pourcentage compris entre 10 et 400.

Méthodes

activate()

Active la fenêtre.

activateNext()

Active la fenêtre suivante.

activatePrevious()

Active la fenêtre précédente.

close()

Ferme la fenêtre.

largeScroll(Down, Up, ToRight, ToLeft)

Fait défiler la fenêtre de plusieurs pages. Les downparamètres , up, toRightet toLeft correspondent à l’action de défilement avec les touches Page bas, Page vers le haut, Alt+Page bas et Alt+Page haut sur le clavier.

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.

newWindow()

Ouvre une nouvelle fenêtre Excel.

pointsToScreenPixelsX(Points)

Convertit les points horizontaux en pixels d’écran.

pointsToScreenPixelsY(Points)

Convertit les points verticaux en pixels d’écran.

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

Fait défiler la fenêtre pour afficher la plage spécifiée.

scrollWorkbookTabs(Sheets, Position)

Fait défiler les onglets du classeur.

scrollWorkbookTabs(Sheets, Position)

Fait défiler les onglets du classeur.

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou 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.

smallScroll(Down, Up, ToRight, ToLeft)

Fait défiler la fenêtre d’un certain nombre de lignes ou de colonnes. Les downparamètres , up, toRightet toLeft correspondent à l’action de défilement avec des touches de direction sur le clavier.

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 Excel.Window est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.WindowDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

activeCell

Spécifie la cellule active dans la fenêtre.

readonly activeCell: Excel.Range;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

activePane

Spécifie le volet actif dans la fenêtre.

readonly activePane: Excel.Pane;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

activeWorksheet

Spécifie la feuille active dans la fenêtre.

readonly activeWorksheet: Excel.Worksheet;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

autoFilterDateGroupingEnabled

Spécifie si le regroupement de dates de filtre automatique est activé dans la fenêtre.

autoFilterDateGroupingEnabled: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

enableResize

Spécifie si le redimensionnement est activé pour la fenêtre.

readonly enableResize: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

freezePanes

Spécifie si les volets sont figés dans la fenêtre.

freezePanes: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

height

Spécifie la hauteur de la fenêtre.

height: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

index

Obtient l’index de la fenêtre.

readonly index: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

isVisible

Spécifie si la fenêtre est visible.

isVisible: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

left

Spécifie la distance, en points, entre le bord gauche de l’écran de l’ordinateur et le bord gauche de la fenêtre.

left: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

name

Spécifie le nom de la fenêtre.

name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

panes

Obtient une collection de volets associés à la fenêtre.

readonly panes: Excel.PaneCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

rangeSelection

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.

Obtient la sélection de plage dans la fenêtre.

readonly rangeSelection: Excel.RangeAreas;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

scrollColumn

Spécifie la colonne de défilement de la fenêtre.

scrollColumn: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

scrollRow

Spécifie la ligne de défilement de la fenêtre.

scrollRow: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

showFormulas

Spécifie si les formules sont affichées dans la fenêtre.

showFormulas: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

showGridlines

Spécifie si le quadrillage est affiché dans la fenêtre.

showGridlines: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

showHeadings

Spécifie si les titres sont affichés dans la fenêtre.

showHeadings: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

showHorizontalScrollBar

Spécifie si la barre de défilement horizontale s’affiche dans la fenêtre.

showHorizontalScrollBar: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

showOutline

Spécifie si le plan est affiché dans la fenêtre.

showOutline: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

showRightToLeft

Obtient la valeur de disposition de droite à gauche de la fenêtre. True signifie que la fenêtre utilise la disposition de droite à gauche, false signifie que la fenêtre utilise la disposition de gauche à droite.

readonly showRightToLeft: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

showRuler

Spécifie si la règle est affichée dans la fenêtre.

showRuler: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

showVerticalScrollBar

Spécifie si la barre de défilement verticale s’affiche dans la fenêtre.

showVerticalScrollBar: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

showWhitespace

Spécifie si l’espace blanc est affiché dans la fenêtre.

showWhitespace: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

showWorkbookTabs

Spécifie si les onglets du classeur sont affichés dans la fenêtre.

showWorkbookTabs: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

showZeros

Spécifie si les zéros sont affichés dans la fenêtre.

showZeros: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

split

Spécifie l’état de fractionnement de la fenêtre.

split: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

splitColumn

Spécifie la colonne fractionnée de la fenêtre.

splitColumn: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

splitHorizontal

Spécifie le fractionnement horizontal de la fenêtre.

splitHorizontal: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

splitRow

Spécifie la ligne fractionnée de la fenêtre.

splitRow: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

splitVertical

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

splitVertical: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

tabRatio

Spécifie le rapport de tabulation de la fenêtre.

tabRatio: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

top

Spécifie la distance, en points, entre le bord supérieur de la fenêtre et le bord supérieur de la zone utilisable (sous les menus, les barres d’outils ancrées en haut et la barre de formule).

top: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

type

Spécifie le type de la fenêtre.

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

usableHeight

Spécifie la hauteur utilisable de la fenêtre.

readonly usableHeight: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

usableWidth

Spécifie la largeur utilisable de la fenêtre.

readonly usableWidth: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

view

Spécifie la vue de la fenêtre.

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

visibleRange

Obtient la plage visible de la fenêtre.

readonly visibleRange: Excel.Range;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

width

Spécifie la largeur d’affichage de la fenêtre.

width: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

windowNumber

Obtient le numéro de la fenêtre.

readonly windowNumber: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

windowState

Spécifie l’état de la fenêtre.

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

zoom

Spécifie une valeur entière qui représente la taille d’affichage de la fenêtre. Il peut être défini sur un pourcentage compris entre 10 et 400.

zoom: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

Détails de la méthode

activate()

Active la fenêtre.

activate(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

activateNext()

Active la fenêtre suivante.

activateNext(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

activatePrevious()

Active la fenêtre précédente.

activatePrevious(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

close()

Ferme la fenêtre.

close(): OfficeExtension.ClientResult<boolean>;

Retours

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

largeScroll(Down, Up, ToRight, ToLeft)

Fait défiler la fenêtre de plusieurs pages. Les downparamètres , up, toRightet toLeft correspondent à l’action de défilement avec les touches Page bas, Page vers le haut, Alt+Page bas et Alt+Page haut sur le clavier.

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

Paramètres

Down

number

Up

number

ToRight

number

ToLeft

number

Retours

void

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

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?: Excel.Interfaces.WindowLoadOptions): Excel.Window;

Paramètres

options
Excel.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[]): Excel.Window;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient 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;
        }): Excel.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

newWindow()

Ouvre une nouvelle fenêtre Excel.

newWindow(): Excel.Window;

Retours

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

pointsToScreenPixelsX(Points)

Convertit les points horizontaux en pixels d’écran.

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

Paramètres

Points

number

Retours

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

pointsToScreenPixelsY(Points)

Convertit les points verticaux en pixels d’écran.

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

Paramètres

Points

number

Retours

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

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

Fait défiler la fenêtre pour afficher la plage spécifiée.

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

Paramètres

Left

number

Top

number

Width

number

Height

number

Start

boolean

Retours

void

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

scrollWorkbookTabs(Sheets, Position)

Fait défiler les onglets du classeur.

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

Paramètres

Sheets

number

Retours

void

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

scrollWorkbookTabs(Sheets, Position)

Fait défiler les onglets du classeur.

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

Paramètres

Sheets

number

Position

"First" | "Last"

Retours

void

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties
Excel.Interfaces.WindowUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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: Excel.Window): void;

Paramètres

properties
Excel.Window

Retours

void

smallScroll(Down, Up, ToRight, ToLeft)

Fait défiler la fenêtre d’un certain nombre de lignes ou de colonnes. Les downparamètres , up, toRightet toLeft correspondent à l’action de défilement avec des touches de direction sur le clavier.

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

Paramètres

Down

number

Up

number

ToRight

number

ToLeft

number

Retours

void

Remarques

[ Ensemble d’API : ExcelApiDesktop 1.1 ]

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 Excel.Window est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.WindowDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.WindowData;

Retours