Excel.PageLayout class

Excel がヘッダーとフッターをページ設定オプションで設定した余白に合わせるかどうかを指定します。

alignMarginsHeaderFooter: boolean;

プロパティ値

注釈

API セット: ExcelApiDesktop 1.1

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

blackAndWhite: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.9

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

bottomMargin: number;

プロパティ値

注釈

API セット: ExcelApi 1.9

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

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

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

context: RequestContext;

プロパティ値

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

draftMode: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.9

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

firstPageNumber: number | "";

プロパティ値

注釈

API セット: ExcelApi 1.9

印刷時に使用するワークシートのフッター余白 (ポイント単位)。

footerMargin: number;

プロパティ値

注釈

API セット: ExcelApi 1.9

印刷時に使用するワークシートのヘッダー余白 (ポイント単位)。

headerMargin: number;

プロパティ値

注釈

API セット: ExcelApi 1.9

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

readonly headersFooters: Excel.HeaderFooterGroup;

プロパティ値

注釈

API セット: ExcelApi 1.9

印刷時に使用するワークシートの左余白 (ポイント単位)。

leftMargin: number;

プロパティ値

注釈

API セット: ExcelApi 1.9

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

orientation: 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: 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: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace";

プロパティ値

注釈

API セット: ExcelApi 1.9

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

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

プロパティ値

注釈

API セット: ExcelApi 1.9

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

printGridlines: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.9

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

printHeadings: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.9

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

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

プロパティ値

注釈

API セット: ExcelApi 1.9

水平方向と垂直方向の両方の印刷品質値を含む 2 要素の配列を指定します。 1 つ目は横方向の印刷品質、2 つ目は縦方向の印刷品質です。 一部のプリンターは縦書き印刷品質をサポートしていない場合があり、サポートされている値はプリンターによって異なる場合があります。

printQuality: number[];

プロパティ値

注釈

API セット: ExcelApiDesktop 1.1

印刷時に使用するワークシートの右余白 (ポイント単位)。

rightMargin: number;

プロパティ値

注釈

API セット: ExcelApi 1.9

印刷時に使用するワークシートの上余白 (ポイント単位)。

topMargin: number;

プロパティ値

注釈

API セット: ExcelApi 1.9

ワークシートの印刷ズーム オプション。 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();
});

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

getPrintArea(): Excel.RangeAreas;

返品

注釈

API セット: ExcelApi 1.9

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

getPrintAreaOrNullObject(): Excel.RangeAreas;

返品

注釈

API セット: ExcelApi 1.9

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

getPrintTitleColumns(): Excel.Range;

返品

注釈

API セット: ExcelApi 1.9

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

getPrintTitleColumnsOrNullObject(): Excel.Range;

返品

注釈

API セット: ExcelApi 1.9

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

getPrintTitleRows(): Excel.Range;

返品

注釈

API セット: ExcelApi 1.9

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

getPrintTitleRowsOrNullObject(): Excel.Range;

返品

注釈

API セット: ExcelApi 1.9

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

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

パラメーター

返品

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

load(propertyNames?: string | string[]): Excel.PageLayout;

パラメーター

返品

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.PageLayout;

パラメーター

返品

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

set(properties: Interfaces.PageLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

返品

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

set(properties: Excel.PageLayout): void;

パラメーター

返品

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

setPrintArea(printArea: Range | 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: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions): void;

パラメーター

返品

注釈

API セット: ExcelApi 1.9

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

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

パラメーター

返品

注釈

API セット: ExcelApi 1.9

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

setPrintTitleColumns(printTitleColumns: Range | string): void;

パラメーター

返品

注釈

API セット: ExcelApi 1.9

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

setPrintTitleRows(printTitleRows: 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();
});

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

toJSON(): Excel.Interfaces.PageLayoutData;

返品