Excel.Window class

表示工作簿中的窗口。

扩展

注解

[ API 集:ExcelApiDesktop 1.1 ]

属性

activeCell

指定窗口中的活动单元格。

activePane

指定窗口中的活动窗格。

activeWorksheet

指定窗口中的活动工作表。

autoFilterDateGroupingEnabled

指定是否在窗口中启用自动筛选日期分组。

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

enableResize

指定是否为窗口启用大小调整。

freezePanes

指定窗格是否冻结在窗口中。

height

指定窗口的高度。

index

获取窗口的索引。

isVisible

指定窗口是否可见。

left

指定从计算机屏幕左边缘到窗口左边缘的距离(以磅为单位)。

name

指定窗口的名称。

panes

获取与窗口关联的窗格的集合。

rangeSelection

获取窗口中的区域选择。

scrollColumn

指定窗口的滚动列。

scrollRow

指定窗口的滚动行。

showFormulas

指定是否在窗口中显示公式。

showGridlines

指定是否在窗口中显示网格线。

showHeadings

指定标题是否显示在窗口中。

showHorizontalScrollBar

指定是否在窗口中显示水平滚动条。

showOutline

指定是否在窗口中显示轮廓。

showRightToLeft

获取窗口的从右到左布局值。 True 表示窗口使用从右到左的布局,false 表示窗口使用从左到右的布局。

showRuler

指定是否在窗口中显示标尺。

showVerticalScrollBar

指定是否在窗口中显示垂直滚动条。

showWhitespace

指定是否在窗口中显示空格。

showWorkbookTabs

指定是否在窗口中显示工作簿选项卡。

showZeros

指定是否在窗口中显示零。

split

指定窗口的拆分状态。

splitColumn

指定窗口的拆分列。

splitHorizontal

指定窗口的水平拆分。

splitRow

指定窗口的拆分行。

splitVertical

指定窗口的垂直拆分。

tabRatio

指定窗口的制表符比率。

top

指定从窗口的上边缘到可用区域上边缘的距离(以磅为单位), (菜单下方、停靠在顶部的任何工具栏以及编辑栏) 。

type

指定窗口的类型。

usableHeight

指定窗口的可用高度。

usableWidth

指定窗口的可用宽度。

view

指定窗口的视图。

visibleRange

获取窗口的可见范围。

width

指定窗口的显示宽度。

windowNumber

获取窗口编号。

windowState

指定窗口状态。

zoom

指定表示窗口的显示大小的整数值。 可以将其设置为 10 到 400 之间的百分比。

方法

activate()

激活窗口。

activateNext()

激活下一个窗口。

activatePrevious()

激活上一个窗口。

close()

关闭窗口。

largeScroll(Down, Up, ToRight, ToLeft)

按多个页面滚动窗口。 down uptoRighttoLeft 参数对应于键盘上使用“下一页”、“向上一页”、“Alt+Page Down”和“Alt+Page Up”键滚动的作。

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

newWindow()

打开新的 Excel 窗口。

pointsToScreenPixelsX(Points)

将水平点转换为屏幕像素。

pointsToScreenPixelsY(Points)

将垂直点转换为屏幕像素。

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

滚动窗口以将指定的区域置于视图中。

scrollWorkbookTabs(Sheets, Position)

滚动工作簿选项卡。

scrollWorkbookTabs(Sheets, Position)

滚动工作簿选项卡。

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

smallScroll(Down, Up, ToRight, ToLeft)

按多个行或列滚动窗口。 down uptoRighttoLeft 参数对应于使用键盘上的箭头键滚动的作。

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,依次调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.Window对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.WindowData) ,其中包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

activeCell

指定窗口中的活动单元格。

readonly activeCell: Excel.Range;

属性值

注解

[ API 集:ExcelApiDesktop 1.1 ]

activePane

指定窗口中的活动窗格。

readonly activePane: Excel.Pane;

属性值

注解

[ API 集:ExcelApiDesktop 1.1 ]

activeWorksheet

指定窗口中的活动工作表。

readonly activeWorksheet: Excel.Worksheet;

属性值

注解

[ API 集:ExcelApiDesktop 1.1 ]

autoFilterDateGroupingEnabled

指定是否在窗口中启用自动筛选日期分组。

autoFilterDateGroupingEnabled: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

enableResize

指定是否为窗口启用大小调整。

readonly enableResize: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

freezePanes

指定窗格是否冻结在窗口中。

freezePanes: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

height

指定窗口的高度。

height: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

index

获取窗口的索引。

readonly index: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

isVisible

指定窗口是否可见。

isVisible: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

left

指定从计算机屏幕左边缘到窗口左边缘的距离(以磅为单位)。

left: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

name

指定窗口的名称。

name: string;

属性值

string

注解

[ API 集:ExcelApiDesktop 1.1 ]

panes

获取与窗口关联的窗格的集合。

readonly panes: Excel.PaneCollection;

属性值

注解

[ API 集:ExcelApiDesktop 1.1 ]

rangeSelection

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取窗口中的区域选择。

readonly rangeSelection: Excel.RangeAreas;

属性值

注解

[ API 集:ExcelApi BETA (仅预览版) ]

scrollColumn

指定窗口的滚动列。

scrollColumn: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

scrollRow

指定窗口的滚动行。

scrollRow: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

showFormulas

指定是否在窗口中显示公式。

showFormulas: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

showGridlines

指定是否在窗口中显示网格线。

showGridlines: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

showHeadings

指定标题是否显示在窗口中。

showHeadings: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

showHorizontalScrollBar

指定是否在窗口中显示水平滚动条。

showHorizontalScrollBar: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

showOutline

指定是否在窗口中显示轮廓。

showOutline: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

showRightToLeft

获取窗口的从右到左布局值。 True 表示窗口使用从右到左的布局,false 表示窗口使用从左到右的布局。

readonly showRightToLeft: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

showRuler

指定是否在窗口中显示标尺。

showRuler: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

showVerticalScrollBar

指定是否在窗口中显示垂直滚动条。

showVerticalScrollBar: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

showWhitespace

指定是否在窗口中显示空格。

showWhitespace: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

showWorkbookTabs

指定是否在窗口中显示工作簿选项卡。

showWorkbookTabs: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

showZeros

指定是否在窗口中显示零。

showZeros: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

split

指定窗口的拆分状态。

split: boolean;

属性值

boolean

注解

[ API 集:ExcelApiDesktop 1.1 ]

splitColumn

指定窗口的拆分列。

splitColumn: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

splitHorizontal

指定窗口的水平拆分。

splitHorizontal: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

splitRow

指定窗口的拆分行。

splitRow: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

splitVertical

指定窗口的垂直拆分。

splitVertical: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

tabRatio

指定窗口的制表符比率。

tabRatio: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

top

指定从窗口的上边缘到可用区域上边缘的距离(以磅为单位), (菜单下方、停靠在顶部的任何工具栏以及编辑栏) 。

top: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

type

指定窗口的类型。

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

属性值

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

注解

[ API 集:ExcelApiDesktop 1.1 ]

usableHeight

指定窗口的可用高度。

readonly usableHeight: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

usableWidth

指定窗口的可用宽度。

readonly usableWidth: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

view

指定窗口的视图。

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

属性值

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

注解

[ API 集:ExcelApiDesktop 1.1 ]

visibleRange

获取窗口的可见范围。

readonly visibleRange: Excel.Range;

属性值

注解

[ API 集:ExcelApiDesktop 1.1 ]

width

指定窗口的显示宽度。

width: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

windowNumber

获取窗口编号。

readonly windowNumber: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

windowState

指定窗口状态。

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

属性值

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

注解

[ API 集:ExcelApiDesktop 1.1 ]

zoom

指定表示窗口的显示大小的整数值。 可以将其设置为 10 到 400 之间的百分比。

zoom: number;

属性值

number

注解

[ API 集:ExcelApiDesktop 1.1 ]

方法详细信息

activate()

激活窗口。

activate(): void;

返回

void

注解

[ API 集:ExcelApiDesktop 1.1 ]

activateNext()

激活下一个窗口。

activateNext(): void;

返回

void

注解

[ API 集:ExcelApiDesktop 1.1 ]

activatePrevious()

激活上一个窗口。

activatePrevious(): void;

返回

void

注解

[ API 集:ExcelApiDesktop 1.1 ]

close()

关闭窗口。

close(): OfficeExtension.ClientResult<boolean>;

返回

注解

[ API 集:ExcelApiDesktop 1.1 ]

largeScroll(Down, Up, ToRight, ToLeft)

按多个页面滚动窗口。 down uptoRighttoLeft 参数对应于键盘上使用“下一页”、“向上一页”、“Alt+Page Down”和“Alt+Page Up”键滚动的作。

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

参数

Down

number

Up

number

ToRight

number

ToLeft

number

返回

void

注解

[ API 集:ExcelApiDesktop 1.1 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

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

参数

options
Excel.Interfaces.WindowLoadOptions

提供要加载对象的属性的选项。

返回

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

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

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。

返回

newWindow()

打开新的 Excel 窗口。

newWindow(): Excel.Window;

返回

注解

[ API 集:ExcelApiDesktop 1.1 ]

pointsToScreenPixelsX(Points)

将水平点转换为屏幕像素。

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

参数

Points

number

返回

注解

[ API 集:ExcelApiDesktop 1.1 ]

pointsToScreenPixelsY(Points)

将垂直点转换为屏幕像素。

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

参数

Points

number

返回

注解

[ API 集:ExcelApiDesktop 1.1 ]

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

滚动窗口以将指定的区域置于视图中。

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

参数

Left

number

Top

number

Width

number

Height

number

Start

boolean

返回

void

注解

[ API 集:ExcelApiDesktop 1.1 ]

scrollWorkbookTabs(Sheets, Position)

滚动工作簿选项卡。

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

参数

Sheets

number

返回

void

注解

[ API 集:ExcelApiDesktop 1.1 ]

scrollWorkbookTabs(Sheets, Position)

滚动工作簿选项卡。

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

参数

Sheets

number

Position

"First" | "Last"

返回

void

注解

[ API 集:ExcelApiDesktop 1.1 ]

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

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

参数

properties
Excel.Interfaces.WindowUpdateData

一个 JavaScript 对象,其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

set(properties: Excel.Window): void;

参数

properties
Excel.Window

返回

void

smallScroll(Down, Up, ToRight, ToLeft)

按多个行或列滚动窗口。 down uptoRighttoLeft 参数对应于使用键盘上的箭头键滚动的作。

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

参数

Down

number

Up

number

ToRight

number

ToLeft

number

返回

void

注解

[ API 集:ExcelApiDesktop 1.1 ]

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,依次调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.Window对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.WindowData) ,其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.WindowData;

返回