Excel.PageBreakCollection class

Extends

プロパティ

context

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

items

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

メソッド

add(pageBreakRange)

指定された範囲の左上セルの前に改ページを追加します。Adds a page break before the top-left cell of the range specified.

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

getCount()

コレクション内の改ページの数を取得します。Gets the number of page breaks in the collection.

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

getItem(index)

インデックス経由で改ページ オブジェクトを取得します。Gets a page break object via the index.

[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(option)
removePageBreaks()

コレクション内の手動改ページをすべてリセットします。Resets all manual page breaks in the collection.

[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オブジェクトのメソッドを呼び出します。元Excel.PageBreakCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.PageBreakCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PageBreakCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PageBreakCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

プロパティの詳細

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

items

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

readonly items: Excel.PageBreak[];

プロパティ値

Excel.PageBreak[]

メソッドの詳細

add(pageBreakRange)

指定された範囲の左上セルの前に改ページを追加します。Adds a page break before the top-left cell of the range specified.

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

add(pageBreakRange: Range | string): Excel.PageBreak;

パラメーター

pageBreakRange
Range | string

改ページが追加される直後のセル範囲を指定します。The range immediately after the page break to be added.

戻り値

Examples

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.horizontalPageBreaks.add("A21:E21");
    await context.sync();
});

getCount()

コレクション内の改ページの数を取得します。Gets the number of page breaks in the collection.

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

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

getItem(index)

インデックス経由で改ページ オブジェクトを取得します。Gets a page break object via the index.

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

getItem(index: number): Excel.PageBreak;

パラメーター

index
number

改ページのインデックスです。Index of the page break.

戻り値

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.PageBreakCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PageBreakCollection;

パラメーター

option
Excel.Interfaces.PageBreakCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

戻り値

注釈

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

load(option?: string | string[]): Excel.PageBreakCollection-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.PageBreakCollection - 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.PageBreakCollection-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.PageBreakCollection - 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.PageBreakCollection-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PageBreakCollection - 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.PageBreakCollection;

パラメーター

propertyNames
string | string[]

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

戻り値

load(option)

load(option?: OfficeExtension.LoadOption): Excel.PageBreakCollection;

パラメーター

戻り値

removePageBreaks()

コレクション内の手動改ページをすべてリセットします。Resets all manual page breaks in the collection.

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

removePageBreaks(): void;

戻り値

void

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オブジェクトのメソッドを呼び出します。元Excel.PageBreakCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.PageBreakCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PageBreakCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PageBreakCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.PageBreakCollectionData;

戻り値