ExcelScript.PageLayout interface

ワークシートの白黒印刷オプション。

getBlackAndWhite(): boolean;

戻り値

ポイント単位での印刷に使用するワークシートの下部ページ余白。

getBottomMargin(): number;

戻り値

ワークシートの中央の水平方向のフラグ。 このフラグによって、印刷時、ワークシートのページ中央を水平に設定するかどうかが決定されます。

getCenterHorizontally(): boolean;

戻り値

ワークシートの中央に垂直フラグを設定します。 このフラグによって、印刷時、ワークシートのページ中央を垂直に設定するかどうかが決定されます。

getCenterVertically(): boolean;

戻り値

ワークシートの下書きモード オプション。 true 場合、シートはグラフィックスなしで印刷されます。

getDraftMode(): boolean;

戻り値

印刷するワークシートの最初のページ番号。 null値は、"自動" ページ番号を表します。

getFirstPageNumber(): number | "";

戻り値

印刷時に使用するワークシートのフッター余白をポイント単位で指定します。

getFooterMargin(): number;

戻り値

印刷時に使用するワークシートのヘッダー余白をポイント単位で指定します。

getHeaderMargin(): number;

戻り値

ワークシートのヘッダーとフッターの構成。

getHeadersFooters(): HeaderFooterGroup;

戻り値

印刷時に使用するワークシートの左余白をポイント単位で指定します。

getLeftMargin(): number;

戻り値

ページのワークシートの向き。

getOrientation(): PageOrientation;

戻り値

ページのワークシートの用紙サイズ。

getPaperSize(): PaperType;

戻り値

ワークシートの印刷領域を表す 1 つまたは複数の四角形の範囲を含む RangeAreas オブジェクトを取得します。 印刷領域がない場合、このメソッドは undefinedを返します。

getPrintArea(): RangeAreas;

戻り値

印刷時にワークシートのコメントを表示するかどうかを指定します。

getPrintComments(): PrintComments;

戻り値

ワークシートの印刷エラー オプション。

getPrintErrors(): PrintErrorType;

戻り値

ワークシートの目盛線を印刷するかどうかを指定します。

getPrintGridlines(): boolean;

戻り値

ワークシートの見出しを印刷するかどうかを指定します。

getPrintHeadings(): boolean;

戻り値

ワークシートのページ印刷順序オプション。 これによって、印刷されるページ番号の処理に使用する順序が指定されます。

getPrintOrder(): PrintOrder;

戻り値

タイトル列を表す範囲オブジェクトを取得します。 設定されていない場合、このメソッドは undefinedを返します。

getPrintTitleColumns(): Range;

戻り値

タイトル行を表す範囲オブジェクトを取得します。 設定されていない場合、このメソッドは undefinedを返します。

getPrintTitleRows(): Range;

戻り値

印刷時に使用するワークシートの右余白をポイント単位で指定します。

getRightMargin(): number;

戻り値

印刷時に使用するワークシートの上余白をポイント単位で指定します。

getTopMargin(): number;

戻り値

ワークシートの印刷ズーム オプション。 PageLayoutZoomOptions オブジェクトは JSON オブジェクトとして設定する必要があります (x.zoom.scale = ...ではなくx.zoom = {...}を使用します)。

getZoom(): PageLayoutZoomOptions;

戻り値

ワークシートの白黒印刷オプション。

setBlackAndWhite(blackAndWhite: boolean): void;

パラメーター

戻り値

ポイント単位での印刷に使用するワークシートの下部ページ余白。

setBottomMargin(bottomMargin: number): void;

パラメーター

戻り値

ワークシートの中央の水平方向のフラグ。 このフラグによって、印刷時、ワークシートのページ中央を水平に設定するかどうかが決定されます。

setCenterHorizontally(centerHorizontally: boolean): void;

パラメーター

戻り値

ワークシートの中央に垂直フラグを設定します。 このフラグによって、印刷時、ワークシートのページ中央を垂直に設定するかどうかが決定されます。

setCenterVertically(centerVertically: boolean): void;

パラメーター

戻り値

ワークシートの下書きモード オプション。 true 場合、シートはグラフィックスなしで印刷されます。

setDraftMode(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);
  });
}

印刷するワークシートの最初のページ番号。 null値は、"自動" ページ番号を表します。

setFirstPageNumber(firstPageNumber: number | ""): void;

パラメーター

戻り値

印刷時に使用するワークシートのフッター余白をポイント単位で指定します。

setFooterMargin(footerMargin: number): void;

パラメーター

戻り値

印刷時に使用するワークシートのヘッダー余白をポイント単位で指定します。

setHeaderMargin(headerMargin: number): void;

パラメーター

戻り値

印刷時に使用するワークシートの左余白をポイント単位で指定します。

setLeftMargin(leftMargin: number): void;

パラメーター

戻り値

ページのワークシートの向き。

setOrientation(orientation: 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: 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: Range | RangeAreas | string): void;

パラメーター

戻り値

印刷時にワークシートのコメントを表示するかどうかを指定します。

setPrintComments(printComments: 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: PrintErrorType): void;

パラメーター

戻り値

ワークシートの目盛線を印刷するかどうかを指定します。

setPrintGridlines(printGridlines: boolean): void;

パラメーター

戻り値

ワークシートの見出しを印刷するかどうかを指定します。

setPrintHeadings(printHeadings: boolean): void;

パラメーター

戻り値

ワークシートのページ余白を単位で設定します。

setPrintMargins(
            unit: PrintMarginUnit,
            marginOptions: PageLayoutMarginOptions
        ): void;

パラメーター

戻り値

ワークシートのページ印刷順序オプション。 これによって、印刷されるページ番号の処理に使用する順序が指定されます。

setPrintOrder(printOrder: 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: Range | string): void;

パラメーター

戻り値

セルを含む行を、印刷時、ワークシートの各ページの上で繰り返すように設定します。

setPrintTitleRows(printTitleRows: Range | string): void;

パラメーター

戻り値

印刷時に使用するワークシートの右余白をポイント単位で指定します。

setRightMargin(rightMargin: number): void;

パラメーター

戻り値

印刷時に使用するワークシートの上余白をポイント単位で指定します。

setTopMargin(topMargin: number): void;

パラメーター

戻り値

ワークシートの印刷ズーム オプション。 PageLayoutZoomOptions オブジェクトは JSON オブジェクトとして設定する必要があります (x.zoom.scale = ...ではなくx.zoom = {...}を使用します)。

setZoom(zoom: PageLayoutZoomOptions): 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)
}