Excel.PageLayout class

プリンター固有の実装に依存しないレイアウトと印刷設定を表します。 これらの設定には、余白、印刷の向き、ページ番号、タイトル行、および印刷範囲が含まれます。

Extends

注釈

[ API セット: ExcelApi 1.9 ]

プロパティ

blackAndWhite

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

bottomMargin

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

centerHorizontally

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

centerVertically

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

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

draftMode

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

firstPageNumber

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

footerMargin

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

headerMargin

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

headersFooters

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

leftMargin

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

orientation

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

paperSize

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

printComments

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

printErrors

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

printGridlines

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

printHeadings

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

printOrder

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

rightMargin

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

topMargin

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

zoom

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

メソッド

getPrintArea()

ワークシートの印刷領域を表す 1 つまたは複数の四角形の範囲を含む RangeAreas オブジェクトを取得します。 印刷領域がない場合は、 ItemNotFound エラーがスローされます。

getPrintAreaOrNullObject()

ワークシートの印刷領域を表す 1 つまたは複数の四角形の範囲を含む RangeAreas オブジェクトを取得します。 印刷領域がない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getPrintTitleColumns()

タイトル列を表す範囲オブジェクトを取得します。

getPrintTitleColumnsOrNullObject()

タイトル列を表す範囲オブジェクトを取得します。 設定されていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getPrintTitleRows()

タイトル行を表す範囲オブジェクトを取得します。

getPrintTitleRowsOrNullObject()

タイトル行を表す範囲オブジェクトを取得します。 設定されていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

setPrintArea(printArea)

ワークシートの印刷範囲を設定します。

setPrintMargins(unit, marginOptions)

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

setPrintMargins(unitString, marginOptions)

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

setPrintTitleColumns(printTitleColumns)

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

setPrintTitleRows(printTitleRows)

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

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.PageLayout オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.PageLayoutData として型指定) を返します。

プロパティの詳細

blackAndWhite

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

blackAndWhite: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

bottomMargin

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

bottomMargin: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

centerHorizontally

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

centerHorizontally: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

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

注釈

[ API セット: ExcelApi 1.9 ]

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

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

draftMode

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

draftMode: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

firstPageNumber

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

firstPageNumber: number | "";

プロパティ値

number | ""

注釈

[ API セット: ExcelApi 1.9 ]

footerMargin

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

footerMargin: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

headerMargin

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

headerMargin: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

headersFooters

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

readonly headersFooters: Excel.HeaderFooterGroup;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

leftMargin

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

leftMargin: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

orientation

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

orientation: Excel.PageOrientation | "Portrait" | "Landscape";

プロパティ値

Excel.PageOrientation | "Portrait" | "Landscape"

注釈

[ API セット: ExcelApi 1.9 ]

// 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"

注釈

[ API セット: ExcelApi 1.9 ]

printComments

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

printComments: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace";

プロパティ値

Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace"

注釈

[ API セット: ExcelApi 1.9 ]

printErrors

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

printErrors: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable";

プロパティ値

Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable"

注釈

[ API セット: ExcelApi 1.9 ]

printGridlines

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

printGridlines: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

printHeadings

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

printHeadings: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

printOrder

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

printOrder: Excel.PrintOrder | "DownThenOver" | "OverThenDown";

プロパティ値

Excel.PrintOrder | "DownThenOver" | "OverThenDown"

注釈

[ API セット: ExcelApi 1.9 ]

rightMargin

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

rightMargin: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

topMargin

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

topMargin: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

zoom

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

zoom: Excel.PageLayoutZoomOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

// 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()

ワークシートの印刷領域を表す 1 つまたは複数の四角形の範囲を含む RangeAreas オブジェクトを取得します。 印刷領域がない場合は、 ItemNotFound エラーがスローされます。

getPrintArea(): Excel.RangeAreas;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

getPrintAreaOrNullObject()

ワークシートの印刷領域を表す 1 つまたは複数の四角形の範囲を含む RangeAreas オブジェクトを取得します。 印刷領域がない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getPrintAreaOrNullObject(): Excel.RangeAreas;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

getPrintTitleColumns()

タイトル列を表す範囲オブジェクトを取得します。

getPrintTitleColumns(): Excel.Range;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

getPrintTitleColumnsOrNullObject()

タイトル列を表す範囲オブジェクトを取得します。 設定されていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getPrintTitleColumnsOrNullObject(): Excel.Range;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

getPrintTitleRows()

タイトル行を表す範囲オブジェクトを取得します。

getPrintTitleRows(): Excel.Range;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

getPrintTitleRowsOrNullObject()

タイトル行を表す範囲オブジェクトを取得します。 設定されていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getPrintTitleRowsOrNullObject(): Excel.Range;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.PageLayoutLoadOptions): Excel.PageLayout;

パラメーター

options
Excel.Interfaces.PageLayoutLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

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

注釈

[ API セット: ExcelApi 1.9 ]

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

パラメーター

unit
Excel.PrintMarginUnit

提供された余白の測定単位。

marginOptions
Excel.PageLayoutMarginOptions

設定する余白の値。 指定されていない余白は変更されません。

戻り値

void

注釈

[ API セット: ExcelApi 1.9 ]

setPrintMargins(unitString, marginOptions)

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

setPrintMargins(unitString: "Points" | "Inches" | "Centimeters", marginOptions: Excel.PageLayoutMarginOptions): void;

パラメーター

unitString

"Points" | "Inches" | "Centimeters"

提供された余白の測定単位。

marginOptions
Excel.PageLayoutMarginOptions

設定する余白の値。 指定されていない余白は変更されません。

戻り値

void

注釈

[ API セット: ExcelApi 1.9 ]

setPrintTitleColumns(printTitleColumns)

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

setPrintTitleColumns(printTitleColumns: Range | string): void;

パラメーター

printTitleColumns

Excel.Range | string

各ページの左側に繰り返される列。 範囲は、有効にするには列全体にまたがる必要があります。

戻り値

void

注釈

[ API セット: ExcelApi 1.9 ]

setPrintTitleRows(printTitleRows)

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

setPrintTitleRows(printTitleRows: Range | string): void;

パラメーター

printTitleRows

Excel.Range | string

各ページの上部で繰り返される行。 範囲は、有効にするには行全体にまたがる必要があります。

戻り値

void

注釈

[ API セット: ExcelApi 1.9 ]

// 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()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.PageLayout オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.PageLayoutData として型指定) を返します。

toJSON(): Excel.Interfaces.PageLayoutData;

戻り値