Word.Window class
表示显示文档的窗口。 可拆分窗口以包含多个阅读窗格。
注解
使用方
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/36-pages/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");
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}`);
}
});
属性
| active |
获取窗口中的活动窗格。 |
| are |
指定为窗口还是窗格显示标尺。 |
| are |
指定批注、脚注、尾注和超链接是否显示为提示。 |
| are |
指定文档中页面的缩略图是否显示在 Microsoft Word 文档窗口的左侧。 |
| caption | 指定文档或应用程序窗口的标题栏中显示的窗口的描述文字文本。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| height | 指定窗口 (的高度(以) 点为单位)。 |
| horizontal |
指定水平滚动位置,以文档宽度的百分比表示。 |
| ime |
指定日文输入法编辑器 (IME) 的默认启动模式。 |
| index | 获取项目在集合中的位置。 |
| is |
指定窗口是否处于活动状态。 |
| is |
指定文档结构图是否可见。 |
| is |
指定电子邮件标题在文档窗口中是否可见。 默认值为 |
| is |
指定是否为窗口显示水平滚动条。 |
| is |
指定垂直滚动条是否显示在文档窗口的左侧。 |
| is |
指定垂直标尺是否在文档窗口的右侧显示在页面视图中。 |
| is |
指定窗口是否拆分为多个窗格。 |
| is |
指定为窗口还是窗格显示垂直标尺。 |
| is |
指定是否为窗口显示垂直滚动条。 |
| is |
指定窗口是否可见。 |
| left | 指定窗口的水平位置(以磅为单位)。 |
| next | 获取打开的文档窗口集合中的下一个文档窗口。 |
| panes | 获取窗口中的窗格集合。 |
| previous | 获取集合打开文档窗口中的上一个文档窗口。 |
| show |
指定 Microsoft Word 在比较和合并后如何显示源文档。 |
| split |
指定窗口的垂直拆分百分比。 |
| state | 指定文档窗口或任务窗口的状态。 |
| style |
指定样式区域的宽度(以磅为单位)。 |
| top | 指定文档窗口的垂直位置(以磅为单位)。 |
| type | 获取窗口类型。 |
| usable |
获取文档窗口中活动工作区域) 的高度 ((以磅为单位)。 |
| usable |
获取文档窗口中活动工作区域) 的宽度 ((以磅为单位)。 |
| vertical |
指定垂直滚动位置,以文档长度的百分比表示。 |
| view | 获取 |
| width | 指定文档窗口的宽度(以磅为单位)。 |
| window |
获取表示窗口位置的整数。 |
方法
| activate() | 激活窗口。 |
| close(options) | 关闭窗口。 |
| large |
按指定屏幕数滚动窗口。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| page |
逐页滚动浏览窗口。 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象,也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象,同时在对象上设置多个属性。 |
| set |
将文档窗口的焦点设置为电子邮件的正文。 |
| small |
按指定的行数滚动窗口。 “线”对应于单击滚动条上的滚动箭头一次所滚动的距离。 |
| toggle |
显示或隐藏功能区。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
activePane
获取窗口中的活动窗格。
readonly activePane: Word.Pane;
属性值
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/36-pages/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
areScreenTipsDisplayed
指定批注、脚注、尾注和超链接是否显示为提示。
readonly areScreenTipsDisplayed: boolean;
属性值
boolean
注解
areThumbnailsDisplayed
指定文档中页面的缩略图是否显示在 Microsoft Word 文档窗口的左侧。
areThumbnailsDisplayed: boolean;
属性值
boolean
注解
caption
context
height
horizontalPercentScrolled
imeMode
指定日文输入法编辑器 (IME) 的默认启动模式。
imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul";
属性值
Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"
注解
index
isActive
isDocumentMapVisible
isEnvelopeVisible
isHorizontalScrollBarDisplayed
isLeftScrollBarDisplayed
isRightRulerDisplayed
isSplit
isVerticalRulerDisplayed
isVerticalScrollBarDisplayed
isVisible
left
next
panes
获取窗口中的窗格集合。
readonly panes: Word.PaneCollection;
属性值
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/36-pages/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
showSourceDocuments
指定 Microsoft Word 在比较和合并后如何显示源文档。
showSourceDocuments: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both";
属性值
Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"
注解
splitVertical
state
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
指定文档窗口或任务窗口的状态。
state: Word.WindowState | "Normal" | "Maximize" | "Minimize";
属性值
Word.WindowState | "Normal" | "Maximize" | "Minimize"
注解
styleAreaWidth
top
type
获取窗口类型。
readonly type: Word.WindowType | "Document" | "Template";
属性值
Word.WindowType | "Document" | "Template"
注解
usableHeight
usableWidth
verticalPercentScrolled
view
width
windowNumber
方法详细信息
activate()
close(options)
关闭窗口。
close(options?: Word.WindowCloseOptions): void;
参数
- options
- Word.WindowCloseOptions
可选。 用于定义是否在关闭之前保存更改以及是否路由文档的选项。
返回
void
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/close-document-window.yaml
// Closes the active document window with Word's prompt-to-save option.
if (!Office.context.requirements.isSetSupported("WordApiDesktop", "1.4")) {
console.error("This sample requires WordApiDesktop 1.4 or later.");
return;
}
await Word.run(async (context) => {
const window: Word.Window = context.document.activeWindow;
const saveChanges: Word.SaveConfiguration = Word.SaveConfiguration.promptToSaveChanges;
const closeOptions: Word.WindowCloseOptions = { saveChanges };
console.log("About to close the document window...");
window.close(closeOptions);
await context.sync();
});
largeScroll(options)
按指定屏幕数滚动窗口。
largeScroll(options?: Word.WindowScrollOptions): void;
参数
- options
- Word.WindowScrollOptions
可选。 按指定屏幕数滚动窗口的选项。 如果未指定任何选项,窗口将向下滚动一个屏幕。
返回
void
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.WindowLoadOptions): Word.Window;
参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.Window;
参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Window;
参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串,以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
pageScroll(options)
逐页滚动浏览窗口。
pageScroll(options?: Word.WindowPageScrollOptions): void;
参数
- options
- Word.WindowPageScrollOptions
可选。 用于逐页滚动窗口的选项。
返回
void
注解
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象,也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void;
参数
- properties
- Word.Interfaces.WindowUpdateData
一个 JavaScript 对象,其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
setFocus()
smallScroll(options)
按指定的行数滚动窗口。 “线”对应于单击滚动条上的滚动箭头一次所滚动的距离。
smallScroll(options?: Word.WindowScrollOptions): void;
参数
- options
- Word.WindowScrollOptions
可选。 按指定行数滚动窗口的选项。 如果未指定任何选项,窗口将向下滚动一行。
返回
void
注解
toggleRibbon()
toJSON()
覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.Window 对象是 API 对象, toJSON 但该方法返回一个纯 JavaScript 对象, (类型化为 Word.Interfaces.WindowData) ,其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Word.Interfaces.WindowData;
返回
track()
根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象,并且在“.run”批处理的顺序执行之外使用此对象,并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误,则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分,您还应跟踪父集合。
track(): Word.Window;
返回
untrack()
释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.Window;