Excel.PageLayout class

Extends

プロパティ

blackAndWhite

ワークシートの白黒印刷オプションを取得または設定します。Gets or sets the worksheet's black and white print option.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

bottomMargin

ポイント単位印刷に使用するワークシートの下部ページ余白を取得または設定します。Gets or sets the worksheet's bottom page margin to use for printing in points.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

centerHorizontally

ワークシートの [ページ中央] の [水平] フラグを取得または設定します。Gets or sets the worksheet's center horizontally flag. このフラグによって、印刷時、ワークシートのページ中央を水平に設定するかどうかが決定されます。This flag determines whether the worksheet will be centered horizontally when it's printed.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

centerVertically

ワークシートの [ページ中央] の [垂直] フラグを取得または設定します。Gets or sets the worksheet's center vertically flag. このフラグによって、印刷時、ワークシートのページ中央を垂直に設定するかどうかが決定されます。This flag determines whether the worksheet will be centered vertically when it's printed.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

draftMode

ワークシートの下書きモード オプションを取得または設定します。Gets or sets the worksheet's draft mode option. true の場合、グラフィックスなしでシートが印刷されます。If true the sheet will be printed without graphics.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

firstPageNumber

印刷するワークシートの最初のページ番号を取得または設定します。Gets or sets the worksheet's first page number to print. null 値は "自動" ページ番号を表します。Null value represents "auto" page numbering.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

footerMargin

印刷時に使用するワークシートのフッター余白 (ポイント数) を取得または設定します。Gets or sets the worksheet's footer margin, in points, for use when printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

headerMargin

印刷時に使用するワークシートのヘッダー余白 (ポイント数) を取得または設定します。Gets or sets the worksheet's header margin, in points, for use when printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

headersFooters

ワークシートのヘッダーとフッターの構成。Header and footer configuration for the worksheet.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

leftMargin

印刷時に使用するワークシートの左余白 (ポイント数) を取得または設定します。Gets or sets the worksheet's left margin, in points, for use when printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

orientation

ワークシートのページの向きを取得または設定します。Gets or sets the worksheet's orientation of the page.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

paperSize

ワークシートのページの用紙サイズを取得または設定します。Gets or sets the worksheet's paper size of the page.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

printComments

印刷時、ワークシートのコメントを表示するかどうかを取得または設定します。Gets or sets whether the worksheet's comments should be displayed when printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

printErrors

ワークシートの印刷エラー オプションを取得または設定します。Gets or sets the worksheet's print errors option.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

printGridlines

ワークシートの印刷目盛線フラグを取得または設定します。Gets or sets the worksheet's print gridlines flag. このフラグによって、目盛線を印刷するかどうかが決定されます。This flag determines whether gridlines will be printed or not.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

printHeadings

ワークシートの見出し印刷フラグを取得または設定します。Gets or sets the worksheet's print headings flag. このフラグによって、見出しを印刷するかどうかが決定されます。This flag determines whether headings will be printed or not.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

printOrder

ワークシートのページ印刷順序オプションを取得または設定します。Gets or sets the worksheet's page print order option. これによって、印刷されるページ番号の処理に使用する順序が指定されます。This specifies the order to use for processing the page number printed.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

rightMargin

印刷時に使用するワークシートの右余白 (ポイント数) を取得または設定します。Gets or sets the worksheet's right margin, in points, for use when printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

topMargin

印刷時に使用するワークシートの上余白 (ポイント数) を取得または設定します。Gets or sets the worksheet's top margin, in points, for use when printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

zoom

ワークシートの拡大印刷オプションを取得または設定します。Gets or sets the worksheet's print zoom options. PageLayoutZoomOptionsオブジェクトは JSON オブジェクトとして設定する必要がx.zoom = {...}あります (の代わりに使用します)。x.zoom.scale = ...The PageLayoutZoomOptions object must be set as a JSON object (use x.zoom = {...} instead of x.zoom.scale = ...).

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

メソッド

getPrintArea()

ワークシートの印刷範囲を表し、1 つまたは複数の長方形範囲で構成される RangeAreas オブジェクトを取得します。Gets the RangeAreas object, comprising one or more rectangular ranges, that represents the print area for the worksheet. 印刷範囲がない場合、ItemNotFound エラーがスローされます。If there is no print area, an ItemNotFound error will be thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getPrintAreaOrNullObject()

ワークシートの印刷範囲を表し、1 つまたは複数の長方形範囲で構成される RangeAreas オブジェクトを取得します。Gets the RangeAreas object, comprising one or more rectangular ranges, that represents the print area for the worksheet. 印刷範囲がない場合、null オブジェクトが返されます。If there is no print area, a null object will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getPrintTitleColumns()

タイトル列を表す範囲オブジェクトを取得します。Gets the range object representing the title columns.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getPrintTitleColumnsOrNullObject()

タイトル列を表す範囲オブジェクトを取得します。Gets the range object representing the title columns. 設定されていない場合、null オブジェクトが返されます。If not set, this will return a null object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getPrintTitleRows()

タイトル行を表す範囲オブジェクトを取得します。Gets the range object representing the title rows.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getPrintTitleRowsOrNullObject()

タイトル行を表す範囲オブジェクトを取得します。Gets the range object representing the title rows. 設定されていない場合、null オブジェクトが返されます。If not set, this will return a null object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

setPrintArea(printArea)

ワークシートの印刷範囲を設定します。Sets the worksheet's print area.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setPrintMargins(unit, marginOptions)

ワークシートのページ余白を単位で設定します。Sets the worksheet's page margins with units.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setPrintMargins(unitString, marginOptions)

ワークシートのページ余白を単位で設定します。Sets the worksheet's page margins with units.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setPrintTitleColumns(printTitleColumns)

セルを含む列を、印刷時、ワークシートの各ページの左で繰り返すように設定します。Sets the columns that contain the cells to be repeated at the left of each page of the worksheet for printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setPrintTitleRows(printTitleRows)

セルを含む行を、印刷時、ワークシートの各ページの上で繰り返すように設定します。Sets the rows that contain the cells to be repeated at the top of each page of the worksheet for printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の PageLayout オブジェクトは API オブジェクトであるのに対し、 toJSONメソッドはプレーンな JavaScript オブジェクトを返します (型はExcel.Interfaces.PageLayoutData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PageLayout object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PageLayoutData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

blackAndWhite

ワークシートの白黒印刷オプションを取得または設定します。Gets or sets the worksheet's black and white print option.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

blackAndWhite: boolean;

プロパティ値

boolean

bottomMargin

ポイント単位印刷に使用するワークシートの下部ページ余白を取得または設定します。Gets or sets the worksheet's bottom page margin to use for printing in points.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

bottomMargin: number;

プロパティ値

number

centerHorizontally

ワークシートの [ページ中央] の [水平] フラグを取得または設定します。Gets or sets the worksheet's center horizontally flag. このフラグによって、印刷時、ワークシートのページ中央を水平に設定するかどうかが決定されます。This flag determines whether the worksheet will be centered horizontally when it's printed.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

centerHorizontally: boolean;

プロパティ値

boolean

Examples

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.centerHorizontally = true;
    farmSheet.pageLayout.centerVertically = true;
    await context.sync();
});

centerVertically

ワークシートの [ページ中央] の [垂直] フラグを取得または設定します。Gets or sets the worksheet's center vertically flag. このフラグによって、印刷時、ワークシートのページ中央を垂直に設定するかどうかが決定されます。This flag determines whether the worksheet will be centered vertically when it's printed.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

centerVertically: boolean;

プロパティ値

boolean

Examples

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.centerHorizontally = true;
    farmSheet.pageLayout.centerVertically = true;
    await context.sync();
});

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

draftMode

ワークシートの下書きモード オプションを取得または設定します。Gets or sets the worksheet's draft mode option. true の場合、グラフィックスなしでシートが印刷されます。If true the sheet will be printed without graphics.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

draftMode: boolean;

プロパティ値

boolean

firstPageNumber

印刷するワークシートの最初のページ番号を取得または設定します。Gets or sets the worksheet's first page number to print. null 値は "自動" ページ番号を表します。Null value represents "auto" page numbering.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

firstPageNumber: number | "";

プロパティ値

number | ""

footerMargin

印刷時に使用するワークシートのフッター余白 (ポイント数) を取得または設定します。Gets or sets the worksheet's footer margin, in points, for use when printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

footerMargin: number;

プロパティ値

number

headerMargin

印刷時に使用するワークシートのヘッダー余白 (ポイント数) を取得または設定します。Gets or sets the worksheet's header margin, in points, for use when printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

headerMargin: number;

プロパティ値

number

headersFooters

ワークシートのヘッダーとフッターの構成。Header and footer configuration for the worksheet.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly headersFooters: Excel.HeaderFooterGroup;

プロパティ値

leftMargin

印刷時に使用するワークシートの左余白 (ポイント数) を取得または設定します。Gets or sets the worksheet's left margin, in points, for use when printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

leftMargin: number;

プロパティ値

number

orientation

ワークシートのページの向きを取得または設定します。Gets or sets the worksheet's orientation of the page.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

Excel.PageOrientation | "Portrait" | "Landscape"

Examples

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.orientation = Excel.PageOrientation.landscape;
    await context.sync();
});

paperSize

ワークシートのページの用紙サイズを取得または設定します。Gets or sets the worksheet's paper size of the page.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

印刷時、ワークシートのコメントを表示するかどうかを取得または設定します。Gets or sets whether the worksheet's comments should be displayed when printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

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

printErrors

ワークシートの印刷エラー オプションを取得または設定します。Gets or sets the worksheet's print errors option.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

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

printGridlines

ワークシートの印刷目盛線フラグを取得または設定します。Gets or sets the worksheet's print gridlines flag. このフラグによって、目盛線を印刷するかどうかが決定されます。This flag determines whether gridlines will be printed or not.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

printGridlines: boolean;

プロパティ値

boolean

printHeadings

ワークシートの見出し印刷フラグを取得または設定します。Gets or sets the worksheet's print headings flag. このフラグによって、見出しを印刷するかどうかが決定されます。This flag determines whether headings will be printed or not.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

printHeadings: boolean;

プロパティ値

boolean

printOrder

ワークシートのページ印刷順序オプションを取得または設定します。Gets or sets the worksheet's page print order option. これによって、印刷されるページ番号の処理に使用する順序が指定されます。This specifies the order to use for processing the page number printed.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

Excel.PrintOrder | "DownThenOver" | "OverThenDown"

rightMargin

印刷時に使用するワークシートの右余白 (ポイント数) を取得または設定します。Gets or sets the worksheet's right margin, in points, for use when printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

rightMargin: number;

プロパティ値

number

topMargin

印刷時に使用するワークシートの上余白 (ポイント数) を取得または設定します。Gets or sets the worksheet's top margin, in points, for use when printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

topMargin: number;

プロパティ値

number

zoom

ワークシートの拡大印刷オプションを取得または設定します。Gets or sets the worksheet's print zoom options. PageLayoutZoomOptionsオブジェクトは JSON オブジェクトとして設定する必要がx.zoom = {...}あります (の代わりに使用します)。x.zoom.scale = ...The PageLayoutZoomOptions object must be set as a JSON object (use x.zoom = {...} instead of x.zoom.scale = ...).

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

zoom: Excel.PageLayoutZoomOptions;

プロパティ値

Examples

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.zoom = { scale: 200 };
    await context.sync();
});

メソッドの詳細

getPrintArea()

ワークシートの印刷範囲を表し、1 つまたは複数の長方形範囲で構成される RangeAreas オブジェクトを取得します。Gets the RangeAreas object, comprising one or more rectangular ranges, that represents the print area for the worksheet. 印刷範囲がない場合、ItemNotFound エラーがスローされます。If there is no print area, an ItemNotFound error will be thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getPrintArea(): Excel.RangeAreas;

戻り値

getPrintAreaOrNullObject()

ワークシートの印刷範囲を表し、1 つまたは複数の長方形範囲で構成される RangeAreas オブジェクトを取得します。Gets the RangeAreas object, comprising one or more rectangular ranges, that represents the print area for the worksheet. 印刷範囲がない場合、null オブジェクトが返されます。If there is no print area, a null object will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getPrintAreaOrNullObject(): Excel.RangeAreas;

戻り値

getPrintTitleColumns()

タイトル列を表す範囲オブジェクトを取得します。Gets the range object representing the title columns.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getPrintTitleColumns(): Excel.Range;

戻り値

getPrintTitleColumnsOrNullObject()

タイトル列を表す範囲オブジェクトを取得します。Gets the range object representing the title columns. 設定されていない場合、null オブジェクトが返されます。If not set, this will return a null object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getPrintTitleColumnsOrNullObject(): Excel.Range;

戻り値

getPrintTitleRows()

タイトル行を表す範囲オブジェクトを取得します。Gets the range object representing the title rows.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getPrintTitleRows(): Excel.Range;

戻り値

getPrintTitleRowsOrNullObject()

タイトル行を表す範囲オブジェクトを取得します。Gets the range object representing the title rows. 設定されていない場合、null オブジェクトが返されます。If not set, this will return a null object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getPrintTitleRowsOrNullObject(): Excel.Range;

戻り値

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.PageLayout-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.PageLayout - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.PageLayout-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.PageLayout - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PageLayout-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PageLayout - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNamesAndPaths
{ select?: string; expand?: string; }

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.PageLayoutUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.PageLayout): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.PageLayout): void;

パラメーター

properties
Excel.PageLayout

戻り値

void

setPrintArea(printArea)

ワークシートの印刷範囲を設定します。Sets the worksheet's print area.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setPrintArea(printArea: Range | RangeAreas | string): void;

パラメーター

printArea
Range | RangeAreas | string

印刷するコンテンツの範囲または RangeAreas。The range, or RangeAreas of the content to print.

戻り値

void

Examples

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.setPrintArea("A1:D41");
    await context.sync();
});

setPrintMargins(unit, marginOptions)

ワークシートのページ余白を単位で設定します。Sets the worksheet's page margins with units.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

パラメーター

unit
Excel.PrintMarginUnit

指定された余白の測定単位。Measurement unit for the margins provided.

marginOptions
Excel.PageLayoutMarginOptions

余白の値を設定しても、余白が指定されていない場合、余白は変わりません。Margin values to set, margins not provided will remain unchanged.

戻り値

void

setPrintMargins(unitString, marginOptions)

ワークシートのページ余白を単位で設定します。Sets the worksheet's page margins with units.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

パラメーター

unitString
"Points" | "Inches" | "Centimeters"

指定された余白の測定単位。Measurement unit for the margins provided.

marginOptions
Excel.PageLayoutMarginOptions

余白の値を設定しても、余白が指定されていない場合、余白は変わりません。Margin values to set, margins not provided will remain unchanged.

戻り値

void

setPrintTitleColumns(printTitleColumns)

セルを含む列を、印刷時、ワークシートの各ページの左で繰り返すように設定します。Sets the columns that contain the cells to be repeated at the left of each page of the worksheet for printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setPrintTitleColumns(printTitleColumns: Range | string): void;

パラメーター

printTitleColumns
Range | string

各ページの左側に繰り返す列は、列全体が有効になるように指定する必要があります。The columns to be repeated to the left of each page, range must span the entire column to be valid.

戻り値

void

setPrintTitleRows(printTitleRows)

セルを含む行を、印刷時、ワークシートの各ページの上で繰り返すように設定します。Sets the rows that contain the cells to be repeated at the top of each page of the worksheet for printing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setPrintTitleRows(printTitleRows: Range | string): void;

パラメーター

printTitleRows
Range | string

各ページの先頭に繰り返す行は、行全体が有効になるようにする必要があります。The rows to be repeated at the top of each page, range must span the entire row to be valid.

戻り値

void

Examples

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.setPrintTitleRows("$1:$1");
    await context.sync();
});

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の PageLayout オブジェクトは API オブジェクトであるのに対し、 toJSONメソッドはプレーンな JavaScript オブジェクトを返します (型はExcel.Interfaces.PageLayoutData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PageLayout object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PageLayoutData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.PageLayoutData;

戻り値