Excel.PageBreak class

パッケージ:

excel

Extends

OfficeExtension.ClientObject

注釈

API セット: ExcelApi 1.9

使用元

• Excel.PageBreakCollection: add, getItem, items

プロパティ

columnIndex	改ページの列インデックスを指定します。
context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
rowIndex	改ページの行インデックスを指定します。

メソッド

delete()	改ページ オブジェクトを削除します。
getCellAfterBreak()	改ページの後の最初のセルを取得します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
toJSON()	API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.PageBreak オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.PageBreakData と型指定) を返します。

プロパティの詳細

columnIndex

改ページの列インデックスを指定します。

readonly columnIndex: number;

プロパティ値

number

注釈

API セット: ExcelApi 1.9

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

rowIndex

改ページの行インデックスを指定します。

readonly rowIndex: number;

プロパティ値

number

注釈

API セット: ExcelApi 1.9

メソッドの詳細

delete()

改ページ オブジェクトを削除します。

delete(): void;

返品

void

注釈

API セット: ExcelApi 1.9

getCellAfterBreak()

改ページの後の最初のセルを取得します。

getCellAfterBreak(): Excel.Range;

返品

Excel.Range

注釈

API セット: ExcelApi 1.9

load(options)

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

load(options?: Excel.Interfaces.PageBreakLoadOptions): Excel.PageBreak;

パラメーター

options

Excel.Interfaces.PageBreakLoadOptions

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

返品

Excel.PageBreak

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

Excel.PageBreak

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

Excel.PageBreak

toJSON()

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

toJSON(): Excel.Interfaces.PageBreakData;

返品

Excel.Interfaces.PageBreakData