Excel.PageLayout class
表示不依赖于任何打印机特定实现的布局和打印设置。 这些设置包括页边距、方向、页码编号、标题行，并打印区域。
属性
| align |
指定 Excel 是否将页眉和页脚与页面设置选项中设置的边距对齐。 |
| black |
工作表的黑白打印选项。 |
| bottom |
用于以磅为单位打印的工作表底页边距。 |
| center |
工作表的中心水平标记。 此标记确定在打印时是否水平居中工作表。 |
| center |
工作表的中心垂直标记。 此标记确定在打印时是否垂直居中工作表。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| draft |
工作表的草稿模式选项。 如果 ，将 |
| first |
要打印的工作表的第一个页码。 一个 |
| footer |
打印时使用的工作表页脚边距（以磅为单位）。 |
| header |
打印时使用的工作表页眉边距（以磅为单位）。 |
| headers |
工作表的页眉和页脚配置。 |
| left |
打印时使用的工作表左边距（以磅为单位）。 |
| orientation | 工作表的页面方向。 |
| paper |
页面的工作表纸张大小。 |
| print |
指定打印时是否应显示工作表的注释。 |
| print |
工作表的打印错误选项。 |
| print |
指定是否打印工作表的网格线。 |
| print |
指定是否打印工作表的标题。 |
| print |
工作表的页面打印顺序选项。 它指定用于处理打印页码的顺序。 |
| print |
指定同时包含水平和垂直打印质量值的双元素数组。 第一个要素是水平打印质量，第二个要素是垂直打印质量。 某些打印机可能不支持垂直打印质量，并且支持的值可能因打印机而异。 |
| right |
打印时使用的工作表右边距（以磅为单位）。 |
| top |
打印时使用的工作表上边距（以磅为单位）。 |
| zoom | 工作表的打印缩放选项。 必须将对象 |
方法
| get |
获取 |
| get |
获取 |
| get |
获取表示标题列的 Range 对象。 |
| get |
获取表示标题列的 Range 对象。 如果未设置，则此方法将返回其 |
| get |
获取表示标题行的 Range 对象。 |
| get |
获取表示标题行的 Range 对象。 如果未设置，则此方法将返回其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| set |
设置工作表的打印区域。 |
| set |
设置带单位的工作表的页边距。 |
| set |
设置带单位的工作表的页边距。 |
| set |
设置列，这些列包含要在打印的工作表的每页左侧重复的单元格。 |
| set |
设置行，这些行包含要在打印的工作表的每页顶部重复的单元格。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
alignMarginsHeaderFooter
指定 Excel 是否将页眉和页脚与页面设置选项中设置的边距对齐。
alignMarginsHeaderFooter: boolean;属性值
boolean
注解
blackAndWhite
bottomMargin
centerHorizontally
工作表的中心水平标记。 此标记确定在打印时是否水平居中工作表。
centerHorizontally: boolean;属性值
boolean
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
await Excel.run(async (context) => {
const farmSheet = context.workbook.worksheets.getItem("Print");
farmSheet.pageLayout.centerHorizontally = true;
farmSheet.pageLayout.centerVertically = true;
await context.sync();
});
centerVertically
工作表的中心垂直标记。 此标记确定在打印时是否垂直居中工作表。
centerVertically: boolean;属性值
boolean
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
await Excel.run(async (context) => {
const farmSheet = context.workbook.worksheets.getItem("Print");
farmSheet.pageLayout.centerHorizontally = true;
farmSheet.pageLayout.centerVertically = true;
await context.sync();
});
context
draftMode
firstPageNumber
要打印的工作表的第一个页码。 一个 null 值表示“自动”页码编号。
firstPageNumber: number | "";属性值
number | ""
注解
footerMargin
headerMargin
headersFooters
工作表的页眉和页脚配置。
readonly headersFooters: Excel.HeaderFooterGroup;属性值
注解
leftMargin
orientation
工作表的页面方向。
orientation: Excel.PageOrientation | "Portrait" | "Landscape";属性值
Excel.PageOrientation | "Portrait" | "Landscape"
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
await Excel.run(async (context) => {
const farmSheet = context.workbook.worksheets.getItem("Print");
farmSheet.pageLayout.orientation = Excel.PageOrientation.landscape;
await context.sync();
});
paperSize
页面的工作表纸张大小。
paperSize: Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman";属性值
Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman"
注解
printComments
指定打印时是否应显示工作表的注释。
printComments: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace";属性值
Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace"
注解
printErrors
工作表的打印错误选项。
printErrors: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable";属性值
Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable"
注解
printGridlines
printHeadings
printOrder
工作表的页面打印顺序选项。 它指定用于处理打印页码的顺序。
printOrder: Excel.PrintOrder | "DownThenOver" | "OverThenDown";属性值
Excel.PrintOrder | "DownThenOver" | "OverThenDown"
注解
printQuality
指定同时包含水平和垂直打印质量值的双元素数组。 第一个要素是水平打印质量，第二个要素是垂直打印质量。 某些打印机可能不支持垂直打印质量，并且支持的值可能因打印机而异。
printQuality: number[];属性值
number[]
注解
rightMargin
topMargin
zoom
工作表的打印缩放选项。 必须将对象 PageLayoutZoomOptions 设置为 JSON 对象 (而不是) x.zoom = {...}x.zoom.scale = ... 使用。
zoom: Excel.PageLayoutZoomOptions;属性值
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
await Excel.run(async (context) => {
const farmSheet = context.workbook.worksheets.getItem("Print");
farmSheet.pageLayout.zoom = { scale: 200 };
await context.sync();
});
方法详细信息
getPrintArea()
获取 RangeAreas 对象，该对象包含一个或多个矩形区域，表示工作表的打印区域。 如果没有打印区域， ItemNotFound 将引发错误。
getPrintArea(): Excel.RangeAreas;返回
注解
getPrintAreaOrNullObject()
获取 RangeAreas 对象，该对象包含一个或多个矩形区域，表示工作表的打印区域。 如果没有打印区域，则此方法返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getPrintAreaOrNullObject(): Excel.RangeAreas;返回
注解
getPrintTitleColumns()
getPrintTitleColumnsOrNullObject()
获取表示标题列的 Range 对象。 如果未设置，则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getPrintTitleColumnsOrNullObject(): Excel.Range;返回
注解
getPrintTitleRows()
getPrintTitleRowsOrNullObject()
获取表示标题行的 Range 对象。 如果未设置，则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getPrintTitleRowsOrNullObject(): Excel.Range;返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.PageLayoutLoadOptions): Excel.PageLayout;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.PageLayout;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.PageLayout;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.PageLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Excel.Interfaces.PageLayoutUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
基于现有加载的对象，同时在对象上设置多个属性。
set(properties: Excel.PageLayout): void;参数
- properties
- Excel.PageLayout
返回
void
setPrintArea(printArea)
设置工作表的打印区域。
setPrintArea(printArea: Range | RangeAreas | string): void;参数
- printArea
-
Excel.Range | Excel.RangeAreas | string
要打印的内容的一个或多个区域。
返回
void
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
await Excel.run(async (context) => {
const farmSheet = context.workbook.worksheets.getItem("Print");
farmSheet.pageLayout.setPrintArea("A1:D41");
await context.sync();
});
setPrintMargins(unit, marginOptions)
设置带单位的工作表的页边距。
setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions): void;参数
提供的边距度量单位。
- marginOptions
- Excel.PageLayoutMarginOptions
要设置的边距值。 未提供的边距保持不变。
返回
void
注解
setPrintMargins(unit, marginOptions)
设置带单位的工作表的页边距。
setPrintMargins(unit: "Points" | "Inches" | "Centimeters", marginOptions: Excel.PageLayoutMarginOptions): void;参数
- unit
-
"Points" | "Inches" | "Centimeters"
提供的边距度量单位。
- marginOptions
- Excel.PageLayoutMarginOptions
要设置的边距值。 未提供的边距保持不变。
返回
void
注解
setPrintTitleColumns(printTitleColumns)
设置列，这些列包含要在打印的工作表的每页左侧重复的单元格。
setPrintTitleColumns(printTitleColumns: Range | string): void;参数
- printTitleColumns
-
Excel.Range | string
要在每页左侧重复的列。 范围必须跨越整个列才能有效。
返回
void
注解
setPrintTitleRows(printTitleRows)
设置行，这些行包含要在打印的工作表的每页顶部重复的单元格。
setPrintTitleRows(printTitleRows: Range | string): void;参数
- printTitleRows
-
Excel.Range | string
要在每页顶部重复的行。 范围必须跨越整行才能有效。
返回
void
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
await Excel.run(async (context) => {
const farmSheet = context.workbook.worksheets.getItem("Print");
farmSheet.pageLayout.setPrintTitleRows("$1:$1");
await context.sync();
});
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.PageLayout 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.PageLayoutData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Excel.Interfaces.PageLayoutData;