Excel.Window class
表示工作簿中的窗口。
注解
属性
| active |
指定窗口中的活动单元格。 |
| active |
指定窗口中的活动窗格。 |
| active |
指定窗口中的活动工作表。 |
| auto |
指定是否在窗口中启用自动筛选日期分组。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| enable |
指定是否为窗口启用大小调整。 |
| freeze |
指定窗格是否冻结在窗口中。 |
| height | 指定窗口的高度。 |
| index | 获取窗口的索引。 |
| is |
指定窗口是否可见。 |
| left | 指定从计算机屏幕左边缘到窗口左边缘的距离(以磅为单位)。 |
| name | 指定窗口的名称。 |
| panes | 获取与窗口关联的窗格的集合。 |
| range |
获取窗口中的区域选择。 |
| scroll |
指定窗口的滚动列。 |
| scroll |
指定窗口的滚动行。 |
| show |
指定是否在窗口中显示公式。 |
| show |
指定是否在窗口中显示网格线。 |
| show |
指定标题是否显示在窗口中。 |
| show |
指定是否在窗口中显示水平滚动条。 |
| show |
指定是否在窗口中显示轮廓。 |
| show |
获取窗口的从右到左布局值。 True 表示窗口使用从右到左的布局,false 表示窗口使用从左到右的布局。 |
| show |
指定是否在窗口中显示标尺。 |
| show |
指定是否在窗口中显示垂直滚动条。 |
| show |
指定是否在窗口中显示空格。 |
| show |
指定是否在窗口中显示工作簿选项卡。 |
| show |
指定是否在窗口中显示零。 |
| split | 指定窗口的拆分状态。 |
| split |
指定窗口的拆分列。 |
| split |
指定窗口的水平拆分。 |
| split |
指定窗口的拆分行。 |
| split |
指定窗口的垂直拆分。 |
| tab |
指定窗口的制表符比率。 |
| top | 指定从窗口的上边缘到可用区域上边缘的距离(以磅为单位), (菜单下方、停靠在顶部的任何工具栏以及编辑栏) 。 |
| type | 指定窗口的类型。 |
| usable |
指定窗口的可用高度。 |
| usable |
指定窗口的可用宽度。 |
| view | 指定窗口的视图。 |
| visible |
获取窗口的可见范围。 |
| width | 指定窗口的显示宽度。 |
| window |
获取窗口编号。 |
| window |
指定窗口状态。 |
| zoom | 指定表示窗口的显示大小的整数值。 可以将其设置为 10 到 400 之间的百分比。 |
方法
| activate() | 激活窗口。 |
| activate |
激活下一个窗口。 |
| activate |
激活上一个窗口。 |
| close() | 关闭窗口。 |
| large |
按多个页面滚动窗口。
|
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| new |
打开新的 Excel 窗口。 |
| points |
将水平点转换为屏幕像素。 |
| points |
将垂直点转换为屏幕像素。 |
| scroll |
滚动窗口以将指定的区域置于视图中。 |
| scroll |
滚动工作簿选项卡。 |
| scroll |
滚动工作簿选项卡。 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象,同时对对象设置多个属性。 |
| small |
按多个行或列滚动窗口。
|
| toJSON() | 重写 JavaScript |
属性详细信息
activeCell
activePane
activeWorksheet
指定窗口中的活动工作表。
readonly activeWorksheet: Excel.Worksheet;
属性值
注解
autoFilterDateGroupingEnabled
指定是否在窗口中启用自动筛选日期分组。
autoFilterDateGroupingEnabled: boolean;
属性值
boolean
注解
context
enableResize
freezePanes
height
index
isVisible
left
name
panes
获取与窗口关联的窗格的集合。
readonly panes: Excel.PaneCollection;
属性值
注解
rangeSelection
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取窗口中的区域选择。
readonly rangeSelection: Excel.RangeAreas;
属性值
注解
scrollColumn
scrollRow
showFormulas
showGridlines
showHeadings
showHorizontalScrollBar
showOutline
showRightToLeft
获取窗口的从右到左布局值。 True 表示窗口使用从右到左的布局,false 表示窗口使用从左到右的布局。
readonly showRightToLeft: boolean;
属性值
boolean
注解
showRuler
showVerticalScrollBar
showWhitespace
showWorkbookTabs
showZeros
split
splitColumn
splitHorizontal
splitRow
splitVertical
tabRatio
top
指定从窗口的上边缘到可用区域上边缘的距离(以磅为单位), (菜单下方、停靠在顶部的任何工具栏以及编辑栏) 。
top: number;
属性值
number
注解
type
指定窗口的类型。
readonly type: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";
属性值
Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook"
注解
usableHeight
usableWidth
view
指定窗口的视图。
view: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";
属性值
Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView"
注解
visibleRange
width
windowNumber
windowState
指定窗口状态。
windowState: Excel.WindowState | "maximized" | "minimized" | "normal";
属性值
Excel.WindowState | "maximized" | "minimized" | "normal"
注解
zoom
方法详细信息
activate()
activateNext()
activatePrevious()
close()
largeScroll(Down, Up, ToRight, ToLeft)
按多个页面滚动窗口。
down
、up、 toRight和 toLeft 参数对应于键盘上使用“下一页”、“向上一页”、“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
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.WindowLoadOptions): Excel.Window;
参数
提供要加载对象的属性的选项。
返回
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()
pointsToScreenPixelsX(Points)
将水平点转换为屏幕像素。
pointsToScreenPixelsX(Points: number): OfficeExtension.ClientResult<number>;
参数
- Points
-
number
返回
OfficeExtension.ClientResult<number>
注解
pointsToScreenPixelsY(Points)
将垂直点转换为屏幕像素。
pointsToScreenPixelsY(Points: number): OfficeExtension.ClientResult<number>;
参数
- Points
-
number
返回
OfficeExtension.ClientResult<number>
注解
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
注解
scrollWorkbookTabs(Sheets, Position)
滚动工作簿选项卡。
scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition): void;
参数
- Sheets
-
number
- Position
- Excel.ScrollWorkbookTabPosition
返回
void
注解
scrollWorkbookTabs(Sheets, Position)
滚动工作簿选项卡。
scrollWorkbookTabs(Sheets?: number, Position?: "First" | "Last"): void;
参数
- Sheets
-
number
- Position
-
"First" | "Last"
返回
void
注解
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void;
参数
- properties
- Excel.Interfaces.WindowUpdateData
一个 JavaScript 对象,其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
set(properties)
smallScroll(Down, Up, ToRight, ToLeft)
按多个行或列滚动窗口。
down
、up、 toRight和 toLeft 参数对应于使用键盘上的箭头键滚动的作。
smallScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;
参数
- Down
-
number
- Up
-
number
- ToRight
-
number
- ToLeft
-
number
返回
void
注解
toJSON()
重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(,依次调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.Window对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.WindowData) ,其中包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Excel.Interfaces.WindowData;