ExcelScript.PageLayout interface
プリンター固有の実装に依存しないレイアウトと印刷設定を表します。 これらの設定には、余白、印刷の向き、ページ番号、タイトル行、および印刷範囲が含まれます。
注釈
例
/**
* This script sets some basic page layout settings for printing.
*/
function main(workbook: ExcelScript.Workbook) {
// Go to each worksheet so the print settings are consistent.
workbook.getWorksheets().forEach((sheet) => {
const pageLayout : ExcelScript.PageLayout = sheet.getPageLayout();
// Turn off draft mode so images are printed.
pageLayout.setDraftMode(false);
// Print on 8.5"x11" paper.
pageLayout.setPaperSize(ExcelScript.PaperType.letter);
// Print every page with a landscape orientation.
pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
});
}
メソッド
get |
ワークシートの白黒印刷オプション。 |
get |
ポイント単位での印刷に使用するワークシートの下部ページ余白。 |
get |
ワークシートの中央の水平方向のフラグ。 このフラグによって、印刷時、ワークシートのページ中央を水平に設定するかどうかが決定されます。 |
get |
ワークシートの中央に垂直フラグを設定します。 このフラグによって、印刷時、ワークシートのページ中央を垂直に設定するかどうかが決定されます。 |
get |
ワークシートの下書きモード オプション。 |
get |
印刷するワークシートの最初のページ番号。 |
get |
印刷時に使用するワークシートのフッター余白をポイント単位で指定します。 |
get |
印刷時に使用するワークシートのヘッダー余白をポイント単位で指定します。 |
get |
ワークシートのヘッダーとフッターの構成。 |
get |
印刷時に使用するワークシートの左余白をポイント単位で指定します。 |
get |
ページのワークシートの向き。 |
get |
ページのワークシートの用紙サイズ。 |
get |
ワークシートの印刷領域を表す 1 つまたは複数の四角形の範囲を含む |
get |
印刷時にワークシートのコメントを表示するかどうかを指定します。 |
get |
ワークシートの印刷エラー オプション。 |
get |
ワークシートの目盛線を印刷するかどうかを指定します。 |
get |
ワークシートの見出しを印刷するかどうかを指定します。 |
get |
ワークシートのページ印刷順序オプション。 これによって、印刷されるページ番号の処理に使用する順序が指定されます。 |
get |
タイトル列を表す範囲オブジェクトを取得します。 設定されていない場合、このメソッドは |
get |
タイトル行を表す範囲オブジェクトを取得します。 設定されていない場合、このメソッドは |
get |
印刷時に使用するワークシートの右余白をポイント単位で指定します。 |
get |
印刷時に使用するワークシートの上余白をポイント単位で指定します。 |
get |
ワークシートの印刷ズーム オプション。 |
set |
ワークシートの白黒印刷オプション。 |
set |
ポイント単位での印刷に使用するワークシートの下部ページ余白。 |
set |
ワークシートの中央の水平方向のフラグ。 このフラグによって、印刷時、ワークシートのページ中央を水平に設定するかどうかが決定されます。 |
set |
ワークシートの中央に垂直フラグを設定します。 このフラグによって、印刷時、ワークシートのページ中央を垂直に設定するかどうかが決定されます。 |
set |
ワークシートの下書きモード オプション。 |
set |
印刷するワークシートの最初のページ番号。 |
set |
印刷時に使用するワークシートのフッター余白をポイント単位で指定します。 |
set |
印刷時に使用するワークシートのヘッダー余白をポイント単位で指定します。 |
set |
印刷時に使用するワークシートの左余白をポイント単位で指定します。 |
set |
ページのワークシートの向き。 |
set |
ページのワークシートの用紙サイズ。 |
set |
ワークシートの印刷範囲を設定します。 |
set |
印刷時にワークシートのコメントを表示するかどうかを指定します。 |
set |
ワークシートの印刷エラー オプション。 |
set |
ワークシートの目盛線を印刷するかどうかを指定します。 |
set |
ワークシートの見出しを印刷するかどうかを指定します。 |
set |
ワークシートのページ余白を単位で設定します。 |
set |
ワークシートのページ印刷順序オプション。 これによって、印刷されるページ番号の処理に使用する順序が指定されます。 |
set |
セルを含む列を、印刷時、ワークシートの各ページの左で繰り返すように設定します。 |
set |
セルを含む行を、印刷時、ワークシートの各ページの上で繰り返すように設定します。 |
set |
印刷時に使用するワークシートの右余白をポイント単位で指定します。 |
set |
印刷時に使用するワークシートの上余白をポイント単位で指定します。 |
set |
ワークシートの印刷ズーム オプション。 |
メソッドの詳細
getBlackAndWhite()
ワークシートの白黒印刷オプション。
getBlackAndWhite(): boolean;
戻り値
boolean
getBottomMargin()
ポイント単位での印刷に使用するワークシートの下部ページ余白。
getBottomMargin(): number;
戻り値
number
getCenterHorizontally()
ワークシートの中央の水平方向のフラグ。 このフラグによって、印刷時、ワークシートのページ中央を水平に設定するかどうかが決定されます。
getCenterHorizontally(): boolean;
戻り値
boolean
getCenterVertically()
ワークシートの中央に垂直フラグを設定します。 このフラグによって、印刷時、ワークシートのページ中央を垂直に設定するかどうかが決定されます。
getCenterVertically(): boolean;
戻り値
boolean
getDraftMode()
ワークシートの下書きモード オプション。 true
場合、シートはグラフィックスなしで印刷されます。
getDraftMode(): boolean;
戻り値
boolean
getFirstPageNumber()
印刷するワークシートの最初のページ番号。 null
値は、"自動" ページ番号を表します。
getFirstPageNumber(): number | "";
戻り値
number | ""
getFooterMargin()
印刷時に使用するワークシートのフッター余白をポイント単位で指定します。
getFooterMargin(): number;
戻り値
number
getHeaderMargin()
印刷時に使用するワークシートのヘッダー余白をポイント単位で指定します。
getHeaderMargin(): number;
戻り値
number
getHeadersFooters()
getLeftMargin()
印刷時に使用するワークシートの左余白をポイント単位で指定します。
getLeftMargin(): number;
戻り値
number
getOrientation()
getPaperSize()
getPrintArea()
ワークシートの印刷領域を表す 1 つまたは複数の四角形の範囲を含む RangeAreas
オブジェクトを取得します。 印刷領域がない場合、このメソッドは undefined
を返します。
getPrintArea(): RangeAreas;
戻り値
getPrintComments()
getPrintErrors()
getPrintGridlines()
ワークシートの目盛線を印刷するかどうかを指定します。
getPrintGridlines(): boolean;
戻り値
boolean
getPrintHeadings()
ワークシートの見出しを印刷するかどうかを指定します。
getPrintHeadings(): boolean;
戻り値
boolean
getPrintOrder()
ワークシートのページ印刷順序オプション。 これによって、印刷されるページ番号の処理に使用する順序が指定されます。
getPrintOrder(): PrintOrder;
戻り値
getPrintTitleColumns()
タイトル列を表す範囲オブジェクトを取得します。 設定されていない場合、このメソッドは undefined
を返します。
getPrintTitleColumns(): Range;
戻り値
getPrintTitleRows()
タイトル行を表す範囲オブジェクトを取得します。 設定されていない場合、このメソッドは undefined
を返します。
getPrintTitleRows(): Range;
戻り値
getRightMargin()
印刷時に使用するワークシートの右余白をポイント単位で指定します。
getRightMargin(): number;
戻り値
number
getTopMargin()
印刷時に使用するワークシートの上余白をポイント単位で指定します。
getTopMargin(): number;
戻り値
number
getZoom()
ワークシートの印刷ズーム オプション。 PageLayoutZoomOptions
オブジェクトは JSON オブジェクトとして設定する必要があります (x.zoom.scale = ...
ではなくx.zoom = {...}
を使用します)。
getZoom(): PageLayoutZoomOptions;
戻り値
setBlackAndWhite(blackAndWhite)
ワークシートの白黒印刷オプション。
setBlackAndWhite(blackAndWhite: boolean): void;
パラメーター
- blackAndWhite
-
boolean
戻り値
void
setBottomMargin(bottomMargin)
ポイント単位での印刷に使用するワークシートの下部ページ余白。
setBottomMargin(bottomMargin: number): void;
パラメーター
- bottomMargin
-
number
戻り値
void
setCenterHorizontally(centerHorizontally)
ワークシートの中央の水平方向のフラグ。 このフラグによって、印刷時、ワークシートのページ中央を水平に設定するかどうかが決定されます。
setCenterHorizontally(centerHorizontally: boolean): void;
パラメーター
- centerHorizontally
-
boolean
戻り値
void
setCenterVertically(centerVertically)
ワークシートの中央に垂直フラグを設定します。 このフラグによって、印刷時、ワークシートのページ中央を垂直に設定するかどうかが決定されます。
setCenterVertically(centerVertically: boolean): void;
パラメーター
- centerVertically
-
boolean
戻り値
void
setDraftMode(draftMode)
ワークシートの下書きモード オプション。 true
場合、シートはグラフィックスなしで印刷されます。
setDraftMode(draftMode: boolean): void;
パラメーター
- draftMode
-
boolean
戻り値
void
例
/**
* This script turns off the print setting for draft mode.
*/
function main(workbook: ExcelScript.Workbook) {
// Go to each worksheet so the print settings are consistent.
workbook.getWorksheets().forEach((sheet) => {
const pageLayout = sheet.getPageLayout();
// Turn off draft mode so images are printed.
pageLayout.setDraftMode(false);
});
}
setFirstPageNumber(firstPageNumber)
印刷するワークシートの最初のページ番号。 null
値は、"自動" ページ番号を表します。
setFirstPageNumber(firstPageNumber: number | ""): void;
パラメーター
- firstPageNumber
-
number | ""
戻り値
void
setFooterMargin(footerMargin)
印刷時に使用するワークシートのフッター余白をポイント単位で指定します。
setFooterMargin(footerMargin: number): void;
パラメーター
- footerMargin
-
number
戻り値
void
setHeaderMargin(headerMargin)
印刷時に使用するワークシートのヘッダー余白をポイント単位で指定します。
setHeaderMargin(headerMargin: number): void;
パラメーター
- headerMargin
-
number
戻り値
void
setLeftMargin(leftMargin)
印刷時に使用するワークシートの左余白をポイント単位で指定します。
setLeftMargin(leftMargin: number): void;
パラメーター
- leftMargin
-
number
戻り値
void
setOrientation(orientation)
ページのワークシートの向き。
setOrientation(orientation: PageOrientation): void;
パラメーター
- orientation
- ExcelScript.PageOrientation
戻り値
void
例
/**
* This script sets the printing orientation for the entire workbook.
*/
function main(workbook: ExcelScript.Workbook) {
// Go to each worksheet so the print settings are consistent.
workbook.getWorksheets().forEach((sheet) => {
const pageLayout = sheet.getPageLayout();
// Print every page with a landscape orientation.
pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
});
}
setPaperSize(paperSize)
ページのワークシートの用紙サイズ。
setPaperSize(paperSize: PaperType): void;
パラメーター
- paperSize
- ExcelScript.PaperType
戻り値
void
例
/**
* This script sets the page size for printing.
*/
function main(workbook: ExcelScript.Workbook) {
// Go to each worksheet so the print settings are consistent.
workbook.getWorksheets().forEach((sheet) => {
const pageLayout = sheet.getPageLayout();
// Print on 8.5"x11" paper.
pageLayout.setPaperSize(ExcelScript.PaperType.letter);
});
}
setPrintArea(printArea)
ワークシートの印刷範囲を設定します。
setPrintArea(printArea: Range | RangeAreas | string): void;
パラメーター
- printArea
-
ExcelScript.Range | ExcelScript.RangeAreas | string
印刷するコンテンツの範囲または範囲。
戻り値
void
setPrintComments(printComments)
印刷時にワークシートのコメントを表示するかどうかを指定します。
setPrintComments(printComments: PrintComments): void;
パラメーター
- printComments
- ExcelScript.PrintComments
戻り値
void
例
/**
* This script makes the comments print at the end of the worksheet
* when the workbook is printed.
*/
function main(workbook: ExcelScript.Workbook) {
// Access every worksheet in the workbook.
workbook.getWorksheets().forEach(worksheet => {
// Get the page layout for each sheet.
const layout = worksheet.getPageLayout();
// Change the comment printing settings to print them at the end of the sheet.
layout.setPrintComments(ExcelScript.PrintComments.endSheet);
});
}
setPrintErrors(printErrors)
ワークシートの印刷エラー オプション。
setPrintErrors(printErrors: PrintErrorType): void;
パラメーター
- printErrors
- ExcelScript.PrintErrorType
戻り値
void
setPrintGridlines(printGridlines)
ワークシートの目盛線を印刷するかどうかを指定します。
setPrintGridlines(printGridlines: boolean): void;
パラメーター
- printGridlines
-
boolean
戻り値
void
setPrintHeadings(printHeadings)
ワークシートの見出しを印刷するかどうかを指定します。
setPrintHeadings(printHeadings: boolean): void;
パラメーター
- printHeadings
-
boolean
戻り値
void
setPrintMargins(unit, marginOptions)
ワークシートのページ余白を単位で設定します。
setPrintMargins(
unit: PrintMarginUnit,
marginOptions: PageLayoutMarginOptions
): void;
パラメーター
提供された余白の測定単位。
- marginOptions
- ExcelScript.PageLayoutMarginOptions
設定する余白の値。 指定されていない余白は変更されません。
戻り値
void
setPrintOrder(printOrder)
ワークシートのページ印刷順序オプション。 これによって、印刷されるページ番号の処理に使用する順序が指定されます。
setPrintOrder(printOrder: PrintOrder): void;
パラメーター
- printOrder
- ExcelScript.PrintOrder
戻り値
void
例
/**
* This script sets the print order for every worksheet in the workbook.
* The order of printed content will go over (e.g., left-to-right)
* then down (i.e., top-to-bottom).
*/
function main(workbook: ExcelScript.Workbook) {
// Access every worksheet in the workbook.
workbook.getWorksheets().forEach(worksheet => {
// Get the page layout for each sheet.
const layout: ExcelScript.PageLayout = worksheet.getPageLayout();
// Set the print order to over-then-down.
layout.setPrintOrder(ExcelScript.PrintOrder.overThenDown);
});
}
setPrintTitleColumns(printTitleColumns)
セルを含む列を、印刷時、ワークシートの各ページの左で繰り返すように設定します。
setPrintTitleColumns(printTitleColumns: Range | string): void;
パラメーター
- printTitleColumns
-
ExcelScript.Range | string
各ページの左側に繰り返される列。 範囲は、有効にするには列全体にまたがる必要があります。
戻り値
void
setPrintTitleRows(printTitleRows)
セルを含む行を、印刷時、ワークシートの各ページの上で繰り返すように設定します。
setPrintTitleRows(printTitleRows: Range | string): void;
パラメーター
- printTitleRows
-
ExcelScript.Range | string
各ページの上部で繰り返される行。 範囲は、有効にするには行全体にまたがる必要があります。
戻り値
void
setRightMargin(rightMargin)
印刷時に使用するワークシートの右余白をポイント単位で指定します。
setRightMargin(rightMargin: number): void;
パラメーター
- rightMargin
-
number
戻り値
void
setTopMargin(topMargin)
印刷時に使用するワークシートの上余白をポイント単位で指定します。
setTopMargin(topMargin: number): void;
パラメーター
- topMargin
-
number
戻り値
void
setZoom(zoom)
ワークシートの印刷ズーム オプション。 PageLayoutZoomOptions
オブジェクトは JSON オブジェクトとして設定する必要があります (x.zoom.scale = ...
ではなくx.zoom = {...}
を使用します)。
setZoom(zoom: PageLayoutZoomOptions): void;
パラメーター
戻り値
void
例
/**
* This script changes the scale-to-fit of the page layout.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the current worksheet.
const sheet = workbook.getActiveWorksheet();
// Scale the layout to half size for printing.
const layout = sheet.getPageLayout();
const zoomOptions: ExcelScript.PageLayoutZoomOptions = {
scale: 50
}
layout.setZoom(zoomOptions)
}
Office Scripts