Word.PageSetup class
表示Word文档或节的页面设置设置。
注解
属性
| book |
指定Microsoft Word是否将文档打印为小册子。 |
| book |
指定每个小册子的页数。 |
| book |
指定Microsoft Word是否反转双向或亚洲语言文档的书折打印顺序。 |
| bottom |
指定页面下边缘和正文文本底部边界之间 () 磅的距离。 |
| chars |
指定文档网格中每行的字符数。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| different |
指定第一页是否具有不同的页眉和页脚。 |
| footer |
指定页脚与页面底部之间的距离（以磅为单位）。 |
| gutter | 指定添加到文档或节中每个页面的额外页边距空间) (量（以磅为单位）。 |
| gutter |
指定在文档中显示装订线的哪一侧。 |
| gutter |
指定Microsoft Word基于从右到左语言还是从左到右语言对当前文档使用装订线。 |
| header |
指定页眉与页面顶部之间的距离（以磅为单位）。 |
| layout |
指定当前文档的布局模式。 |
| left |
指定 () 页面左边缘与正文文本的左边界之间的距离（以磅为单位）。 |
| line |
指定一个 |
| lines |
指定文档网格中每页的行数。 |
| mirror |
指定对页的内外边距是否具有相同的宽度。 |
| odd |
指定奇数页和偶数页是否具有不同的页眉和页脚。 |
| orientation | 指定页面的方向。 |
| page |
指定页面高度（以磅为单位）。 |
| page |
指定页面宽度（以磅为单位）。 |
| paper |
指定页面的纸张大小。 |
| right |
指定页面右边缘与正文文本右边界之间的距离 () 磅。 |
| section |
指定指定节的读取顺序和对齐方式。 |
| section |
指定指定对象的分节符类型。 |
| show |
指定是否显示网格。 |
| suppress |
指定是否在下一节的末尾打印了不禁止显示尾注的尾注。 |
| text |
获取一个 |
| top |
指定页面的上边距（以磅为单位）。 |
| two |
指定是否每页打印两页。 |
| vertical |
指定文档或节中每个页面上文本的垂直对齐方式。 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象，同时对对象设置多个属性。 |
| set |
将指定的页面设置格式设为活动文档和所有基于活动模板的新文档的默认格式。 |
| toggle |
在文档或节的纵向和横向页面方向之间切换。 |
| toJSON() | 重写 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 |
属性详细信息
bookFoldPrinting
bookFoldPrintingSheets
bookFoldReversePrinting
指定Microsoft Word是否反转双向或亚洲语言文档的书折打印顺序。
bookFoldReversePrinting: boolean;属性值
boolean
注解
bottomMargin
charsLine
context
differentFirstPageHeaderFooter
指定第一页是否具有不同的页眉和页脚。
differentFirstPageHeaderFooter: boolean;属性值
boolean
注解
footerDistance
gutter
gutterPosition
指定在文档中显示装订线的哪一侧。
gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top";属性值
Word.GutterPosition | "Left" | "Right" | "Top"
注解
gutterStyle
指定Microsoft Word基于从右到左语言还是从左到右语言对当前文档使用装订线。
gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin";属性值
Word.GutterStyle | "Bidirectional" | "Latin"
注解
headerDistance
layoutMode
指定当前文档的布局模式。
layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko";属性值
Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"
注解
leftMargin
lineNumbering
指定一个 LineNumbering 对象，该对象表示对象的 PageSetup 行号。
lineNumbering: Word.LineNumbering;属性值
注解
linesPage
mirrorMargins
oddAndEvenPagesHeaderFooter
指定奇数页和偶数页是否具有不同的页眉和页脚。
oddAndEvenPagesHeaderFooter: boolean;属性值
boolean
注解
orientation
指定页面的方向。
orientation: Word.PageOrientation | "Portrait" | "Landscape";属性值
Word.PageOrientation | "Portrait" | "Landscape"
注解
pageHeight
pageWidth
paperSize
指定页面的纸张大小。
paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom";属性值
Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"
注解
rightMargin
sectionDirection
指定指定节的读取顺序和对齐方式。
sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight";属性值
Word.SectionDirection | "RightToLeft" | "LeftToRight"
注解
sectionStart
指定指定对象的分节符类型。
sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage";属性值
Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"
注解
showGrid
suppressEndnotes
textColumns
获取一个 TextColumnCollection 对象，该对象表示对象的一组文本列 PageSetup 。
readonly textColumns: Word.TextColumnCollection;属性值
注解
topMargin
twoPagesOnOne
verticalAlignment
指定文档或节中每个页面上文本的垂直对齐方式。
verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom";属性值
Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"
注解
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.PageSetup;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.PageSetup;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Word.Interfaces.PageSetupUpdateData
一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
set(properties)
setAsTemplateDefault()
将指定的页面设置格式设为活动文档和所有基于活动模板的新文档的默认格式。
setAsTemplateDefault(): void;返回
void
注解
togglePortrait()
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.PageSetup对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.PageSetupData) ，其中包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Word.Interfaces.PageSetupData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。
track(): Word.PageSetup;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。
untrack(): Word.PageSetup;