文档

Page

更新时间:

本文介绍与文字文档Page相关的API。

Pages

ActiveDocument.ActiveWindow.ActivePane.Pages

获取文档中的所有页面。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.ActiveDocument.ActiveWindow.ActivePane.Pages

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取文档中的所有页面
      const words = await app.ActiveDocument.ActiveWindow.ActivePane.Pages;
    }

属性

ActiveDocument.ActiveWindow.ActivePane.Pages.Count

通过Count属性,您可以获取分页模式下的总页数。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.ActiveDocument.ActiveWindow.ActivePane.Pages.Count

    表达式:文档类型应用对象

  • 返回值

    返回Number表示总页数。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取分页模式下的总页数
      const pages = await app.ActiveDocument.ActiveWindow.ActivePane.Pages.Count;
      console.log(pages);
    }

PageSetup

ActiveDocument.Sections.Item(Index).PageSetup

获取页面属性对象。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActiveDocument.Sections.Item(Index).PageSetup

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取页面属性对象
      const pageSetup = await app.ActiveDocument.Sections.Item(1).PageSetup;
    }

方法

ActiveDocument.Sections.Item(Index).PageSetup.TypesetToPage()

通过TypesetToPage()方法,您可以排版到指定页。由于文字文档是流式排版,因此需要通过PageNum来指定首次加载的页数,滚动页面时进一步加载页面数据。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActiveDocument.Sections.Item(Index).PageSetup.TypesetToPage(PageNum)

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    PageNum

    Number

    指定首次加载的页数。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取页面属性对象
      const pageSetup = await app.ActiveDocument.Sections.Item(1).PageSetup;
    
      //排版到指定页
      await pageSetup.TypesetToPage(2);
    }

属性

ActiveDocument.Sections.Item(Index).PageSetup.PageWidth

通过PageWidth属性,您可以获取页面宽度。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActiveDocument.Sections.Item(Index).PageSetup.PageWidth

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取页面属性对象
      const pageSetup = await app.ActiveDocument.Sections.Item(1).PageSetup;
    
      //获取页面宽度
      const pageWidth = await PageSetup.PageWidth;
      console.log(pageWidth);
    }

    ActiveDocument.Sections.Item(Index).PageSetup.PageHeight

    通过PageHeight属性,您可以获取页面高度。

    重要

    JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActiveDocument.Sections.Item(Index).PageSetup.PageHeight

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 页面属性对象
      const PageSetup = await app.ActiveDocument.Sections.Item(1).PageSetup;
    
      // 获取页面高度
      const PageHeight = await PageSetup.PageHeight;
      console.log(PageHeight);
    }

    ActiveDocument.Sections.Item(Index).PageSetup.TopMargin

  • 通过TopMargin属性,您可以获取页面上边缘与正文文本的上边界之间的距离。

    重要

    JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActiveDocument.Sections.Item(Index).PageSetup.TopMargin

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 页面属性对象
      const PageSetup = await app.ActiveDocument.Sections.Item(1).PageSetup;
    
      // 获取页面上边缘与正文文本的上边界之间的距离
      const TopMargin = await PageSetup.TopMargin;
      console.log(TopMargin);
    }

    ActiveDocument.Sections.Item(Index).PageSetup.BottomMargin

  • 通过BottomMargin属性,您可以获取页面底边与正文文本边界之间的距离。

    重要

    JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActiveDocument.Sections.Item(Index).PageSetup.BottomMargin

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 页面属性对象
      const PageSetup = await app.ActiveDocument.Sections.Item(1).PageSetup;
    
      // 获取页面底边与正文文本边界之间的距离
      const BottomMargin = await PageSetup.BottomMargin;
      console.log(BottomMargin);
    }

    ActiveDocument.Sections.Item(Index).PageSetup.LeftMargin

  • 通过LeftMargin属性,您可以获取页面左边缘与正文左边界之间的距离。

    重要

    JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActiveDocument.Sections.Item(Index).PageSetup.BottomMargin

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 页面属性对象
      const PageSetup = await app.ActiveDocument.Sections.Item(1).PageSetup;
    
      // 获取页面左边缘与正文左边界之间的距离
      const LeftMargin = await PageSetup.LeftMargin;
      console.log(LeftMargin);
    }

    ActiveDocument.Sections.Item(Index).PageSetup.RightMargin

  • 通过LeftMargin属性,您可以获取页面右边距与正文右边界之间的距离。

    重要

    JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActiveDocument.Sections.Item(Index).PageSetup.RightMargin

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 页面属性对象
      const PageSetup = await app.ActiveDocument.Sections.Item(1).PageSetup;
    
      // 获取页面右边距与正文右边界之间的距离
      const RightMargin = await PageSetup.RightMargin;
      console.log(RightMargin);
    }