Word.Window class

获取窗口中的活动窗格。

readonly activePane: Word.Pane;

属性值

注解

[ API 集：WordApiDesktop 1.2 ]

示例

// 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: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定是否将批注、脚注、尾注和超链接显示为提示。

readonly areScreenTipsDisplayed: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定是否沿文档窗口左侧显示文档中页面的缩略图图像Microsoft Word。

areThumbnailsDisplayed: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定在文档或应用程序窗口的标题栏中显示的窗口的描述文字文本。

caption: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

context: RequestContext;

属性值

指定窗口 (的高度（以磅) 为单位）。

readonly height: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

将水平滚动位置指定为文档宽度的百分比。

horizontalPercentScrolled: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定日文输入法编辑器 (IME) 的默认启动模式。

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

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取项在集合中的位置。

readonly index: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定窗口是否处于活动状态。

readonly isActive: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定文档结构图是否可见。

isDocumentMapVisible: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定电子邮件标头在文档窗口中是否可见。 默认值 false为 。

isEnvelopeVisible: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isHorizontalScrollBarDisplayed: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定垂直滚动条是否显示在文档窗口的左侧。

isLeftScrollBarDisplayed: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定垂直标尺是否显示在打印版式视图中文档窗口的右侧。

isRightRulerDisplayed: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定是否将窗口拆分为多个窗格。

isSplit: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定是否为窗口或窗格显示垂直标尺。

isVerticalRulerDisplayed: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isVerticalScrollBarDisplayed: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定窗口是否可见。

isVisible: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定窗口的水平位置，以磅为单位。

readonly left: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取打开的文档窗口集合中的下一个文档窗口。

readonly next: Word.Window;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取窗口中窗格的集合。

readonly panes: Word.PaneCollection;

属性值

注解

[ API 集：WordApiDesktop 1.2 ]

示例

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

获取集合中打开的文档窗口中的上一个文档窗口。

readonly previous: Word.Window;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定Microsoft Word在比较和合并过程后如何显示源文档。

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

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定窗口的垂直拆分百分比。

splitVertical: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定文档窗口或任务窗口的状态。

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

属性值

注解

[ API 集：WordApi BETA (仅预览版) ]

指定样式区域的宽度（以磅为单位）。

styleAreaWidth: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定文档窗口的垂直位置（以磅为单位）。

readonly top: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取窗口类型。

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

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取文档窗口中活动工作区) 高度 (磅。

readonly usableHeight: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取文档窗口中活动工作区 () 的宽度（以磅为单位）。

readonly usableWidth: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

将垂直滚动位置指定为文档长度的百分比。

verticalPercentScrolled: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取 View 表示窗口视图的 对象。

readonly view: Word.View;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定文档窗口的宽度（以磅为单位）。

readonly width: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取表示窗口位置的整数。

readonly windowNumber: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

激活窗口。

activate(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

关闭窗口。

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

示例

// 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?: Word.WindowScrollOptions): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

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

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

参数

返回

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

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

参数

返回

逐页滚动浏览窗口。

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

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

set(properties: Word.Window): void;

参数

返回

将文档窗口的焦点设置为电子邮件的正文。

setFocus(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

按指定行数滚动窗口。 “线条”对应于通过单击滚动条上的滚动箭头一次滚动的距离。

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

显示或隐藏功能区。

toggleRibbon(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

toJSON(): Word.Interfaces.WindowData;

返回

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.Window;

返回

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.Window;

返回