本文介绍与文字文档Section相关的API。
Sections
ActiveDocument.Sections
获取文档中的所有节。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取所有节 const Sections = await app.ActiveDocument.Sections; }
属性
ActiveDocument.Sections.Count
通过Count属性,您可以获取文档中所有节的总数。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Count表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取所有节 const Sections = await app.ActiveDocument.Sections; //获取文档中所有节的总数 const count = await Sections.Count; console.log(count); }
Section
ActiveDocument.Sections.Item(Index)
获取单个节对象。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index)表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象 const Section = await app.ActiveDocument.Sections.Item(Index); }
方法
ActiveDocument.Sections.Item(Index).PageSetup.TypesetToPage(PageNum)
由于Word(文档)是流式排版,您可以通过TypesetToPage()方法,指定首次加载的页数,让文档滚动时进一步加载页面数据。
语法
表达式.ActiveDocument.Sections.Item(Index).PageSetup.TypesetToPage(PageNum)表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
PageNum
Number
是
指定首次加载的页数。
示例
//@file=base.docx 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
通过PageSetup属性,您可以获取单个节的页面属性。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).PageSetup表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取第1个节的页面属性 const Section = await app.ActiveDocument.Sections.Item(1).PageSetup; }
ActiveDocument.Sections.Item(Index).PageSetup.PageWidth
通过PageWidth属性,您可以获取页面宽度。
语法
表达式.ActiveDocument.Sections.Item(Index).PageSetup.PageWidth表达式:文档类型应用对象
示例
//@file=base.docx 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).WaterMarks
通过WaterMarks属性,您可以获取单个节的水印。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取第1个节的水印 const Section = await app.ActiveDocument.Sections.Item(1).WaterMarks; }
HeadersFooters
ActiveDocument.Sections.Item(Index).Headers
获取单个节对象中的所有页眉。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).Headers表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
Type
Enum
是
指定返回的页眉类型。更多信息,请参见WdHeaderFooterIndex。
返回值
返回
HeadersFooters对象示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象中的所有页眉 const Headers = await app.ActiveDocument.Sections.Item(Index).Headers; }
ActiveDocument.Sections.Item(Index).Footers
获取单个节对象中的所有页脚。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).Footers表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
Type
Enum
是
指定返回的页脚类型。更多信息,请参见WdHeaderFooterIndex。
返回值
返回
HeadersFooters对象示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象中的所有页脚 const Headers = await app.ActiveDocument.Sections.Item(Index).Footers; }
属性
ActiveDocument.Sections.Item(Index).Headers.Range
通过Range属性,您可以获取单个节对象页眉中包含的文字部分。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).Headers.Range表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象页眉中包含的文字部分 const Range = await app.ActiveDocument.Sections.Item(1).Headers.Range; }
ActiveDocument.Sections.Item(Index).Footers.Range
通过Range属性,您可以获取单个节对象页脚中包含的文字部分。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).Footers.Range表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象页脚中包含的文字部分 const Range = await app.ActiveDocument.Sections.Item(1).Footers.Range; }