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
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;