Excel.PageBreakCollection class
- Extends
注釈
使用元
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/manage-page-breaks.yaml
// Load and inspect the page breaks in both worksheet collections.
await Excel.run(async (context) => {
const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
const horizontalBreaks: Excel.PageBreakCollection = sheet.horizontalPageBreaks;
const verticalBreaks: Excel.PageBreakCollection = sheet.verticalPageBreaks;
horizontalBreaks.load("items/rowIndex, items/columnIndex");
verticalBreaks.load("items/rowIndex, items/columnIndex");
await context.sync();
console.log(`Horizontal page breaks: ${horizontalBreaks.items.length}`);
horizontalBreaks.items.forEach((pageBreak: Excel.PageBreak) => {
console.log("Horizontal break (zero-based indexes):", {
rowIndex: pageBreak.rowIndex,
columnIndex: pageBreak.columnIndex
});
});
console.log(`Vertical page breaks: ${verticalBreaks.items.length}`);
verticalBreaks.items.forEach((pageBreak: Excel.PageBreak) => {
console.log("Vertical break (zero-based indexes):", {
rowIndex: pageBreak.rowIndex,
columnIndex: pageBreak.columnIndex
});
});
});
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(page |
指定された範囲の左上セルの前に改ページを追加します。 |
| get |
コレクション内の改ページの数を取得します。 |
| get |
インデックス経由で改ページ オブジェクトを取得します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| remove |
コレクション内の手動改ページをすべてリセットします。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
メソッドの詳細
add(pageBreakRange)
指定された範囲の左上セルの前に改ページを追加します。
add(pageBreakRange: Range | string): Excel.PageBreak;パラメーター
- pageBreakRange
-
Excel.Range | string
追加する改ページの直後の範囲。
返品
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml
// Add a horizontal page break before the next group of farm sales.
await Excel.run(async (context) => {
const farmSheet: Excel.Worksheet = context.workbook.worksheets.getItem("Print");
const horizontalBreaks: Excel.PageBreakCollection = farmSheet.horizontalPageBreaks;
horizontalBreaks.add("A21:E21");
await context.sync();
console.log("Added a horizontal page break before row 21.");
});
getCount()
コレクション内の改ページの数を取得します。
getCount(): OfficeExtension.ClientResult<number>;返品
OfficeExtension.ClientResult<number>
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/manage-page-breaks.yaml
// Count page breaks without loading the collection's items.
await Excel.run(async (context) => {
const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
const horizontalBreaks: Excel.PageBreakCollection = sheet.horizontalPageBreaks;
const verticalBreaks: Excel.PageBreakCollection = sheet.verticalPageBreaks;
const horizontalCount: OfficeExtension.ClientResult<number> = horizontalBreaks.getCount();
const verticalCount: OfficeExtension.ClientResult<number> = verticalBreaks.getCount();
await context.sync();
console.log(`Horizontal page breaks: ${horizontalCount.value}`);
console.log(`Vertical page breaks: ${verticalCount.value}`);
});
getItem(index)
インデックス経由で改ページ オブジェクトを取得します。
getItem(index: number): Excel.PageBreak;パラメーター
- index
-
number
改ページのインデックス。
返品
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/manage-page-breaks.yaml
// Inspect the first horizontal break and locate the cell immediately after it.
await Excel.run(async (context) => {
const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
const horizontalBreaks: Excel.PageBreakCollection = sheet.horizontalPageBreaks;
const horizontalCount: OfficeExtension.ClientResult<number> = horizontalBreaks.getCount();
await context.sync();
if (horizontalCount.value === 0) {
console.warn("No horizontal page breaks. Choose Add page breaks first.");
return;
}
const firstBreak: Excel.PageBreak = horizontalBreaks.getItem(0);
const cellAfterBreak: Excel.Range = firstBreak.getCellAfterBreak();
firstBreak.load("rowIndex, columnIndex");
cellAfterBreak.load("address");
await context.sync();
console.log("First horizontal page break (zero-based indexes):", {
rowIndex: firstBreak.rowIndex,
columnIndex: firstBreak.columnIndex,
cellAfterBreak: cellAfterBreak.address
});
});
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.PageBreakCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PageBreakCollection;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.PageBreakCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PageBreakCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
removePageBreaks()
コレクション内の手動改ページをすべてリセットします。
removePageBreaks(): void;返品
void
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/manage-page-breaks.yaml
// Reset all manual page breaks in both worksheet collections.
await Excel.run(async (context) => {
const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
const horizontalBreaks: Excel.PageBreakCollection = sheet.horizontalPageBreaks;
const verticalBreaks: Excel.PageBreakCollection = sheet.verticalPageBreaks;
horizontalBreaks.removePageBreaks();
verticalBreaks.removePageBreaks();
await context.sync();
console.log("Removed all manual page breaks. Choose Count page breaks to verify the collections.");
});
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.PageBreakCollection オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.PageBreakCollectionData として型指定された) を返します。
toJSON(): Excel.Interfaces.PageBreakCollectionData;