Excel.HeaderFooter class

パッケージ:

excel

Extends

OfficeExtension.ClientObject

注釈

API セット: ExcelApi 1.9

使用元

• Excel.HeaderFooterGroup: defaultForAllPages, evenPages, firstPage, oddPages

プロパティ

centerFooter	ワークシートの中央フッター。 フォントの書式設定を適用したり、変数値を挿入したりするには、 https://msdn.microsoft.com/library/bb225426.aspx で指定した書式コードを使用します。
centerFooterPicture	フッターの中央セクションの図を表す HeaderFooterPicture オブジェクトを取得します。
centerHeader	ワークシートの中央ヘッダー。 フォントの書式設定を適用したり、変数値を挿入したりするには、 https://msdn.microsoft.com/library/bb225426.aspx で指定した書式コードを使用します。
centerHeaderPicture	ヘッダーの中央セクションの画像を表す HeaderFooterPicture オブジェクトを取得します。
context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
leftFooter	ワークシートの左フッター。 フォントの書式設定を適用したり、変数値を挿入したりするには、 https://msdn.microsoft.com/library/bb225426.aspx で指定した書式コードを使用します。
leftFooterPicture	フッターの左側セクションの図を表す HeaderFooterPicture オブジェクトを取得します。
leftHeader	ワークシートの左ヘッダー。 フォントの書式設定を適用したり、変数値を挿入したりするには、 https://msdn.microsoft.com/library/bb225426.aspx で指定した書式コードを使用します。
leftHeaderPicture	ヘッダーの左側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。
rightFooter	ワークシートの右フッター。 フォントの書式設定を適用したり、変数値を挿入したりするには、 https://msdn.microsoft.com/library/bb225426.aspx で指定した書式コードを使用します。
rightFooterPicture	フッターの右側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。
rightHeader	ワークシートの右ヘッダー。 フォントの書式設定を適用したり、変数値を挿入したりするには、 https://msdn.microsoft.com/library/bb225426.aspx で指定した書式コードを使用します。
rightHeaderPicture	ヘッダーの右側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。

メソッド

load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()	API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.HeaderFooter オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.HeaderFooterData と型指定) を返します。

プロパティの詳細

centerFooter

ワークシートの中央フッター。 フォントの書式設定を適用したり、変数値を挿入したりするには、 https://msdn.microsoft.com/library/bb225426.aspx で指定した書式コードを使用します。

centerFooter: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.9

centerFooterPicture

フッターの中央セクションの図を表す HeaderFooterPicture オブジェクトを取得します。

readonly centerFooterPicture: Excel.HeaderFooterPicture;

プロパティ値

Excel.HeaderFooterPicture

注釈

API セット: ExcelApiDesktop 1.1

centerHeader

ワークシートの中央ヘッダー。 フォントの書式設定を適用したり、変数値を挿入したりするには、 https://msdn.microsoft.com/library/bb225426.aspx で指定した書式コードを使用します。

centerHeader: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.9

centerHeaderPicture

ヘッダーの中央セクションの画像を表す HeaderFooterPicture オブジェクトを取得します。

readonly centerHeaderPicture: Excel.HeaderFooterPicture;

プロパティ値

Excel.HeaderFooterPicture

注釈

API セット: ExcelApiDesktop 1.1

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

leftFooter

ワークシートの左フッター。 フォントの書式設定を適用したり、変数値を挿入したりするには、 https://msdn.microsoft.com/library/bb225426.aspx で指定した書式コードを使用します。

leftFooter: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.9

leftFooterPicture

フッターの左側セクションの図を表す HeaderFooterPicture オブジェクトを取得します。

readonly leftFooterPicture: Excel.HeaderFooterPicture;

プロパティ値

Excel.HeaderFooterPicture

注釈

API セット: ExcelApiDesktop 1.1

leftHeader

ワークシートの左ヘッダー。 フォントの書式設定を適用したり、変数値を挿入したりするには、 https://msdn.microsoft.com/library/bb225426.aspx で指定した書式コードを使用します。

leftHeader: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.9

leftHeaderPicture

ヘッダーの左側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。

readonly leftHeaderPicture: Excel.HeaderFooterPicture;

プロパティ値

Excel.HeaderFooterPicture

注釈

API セット: ExcelApiDesktop 1.1

rightFooter

ワークシートの右フッター。 フォントの書式設定を適用したり、変数値を挿入したりするには、 https://msdn.microsoft.com/library/bb225426.aspx で指定した書式コードを使用します。

rightFooter: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.9

rightFooterPicture

フッターの右側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。

readonly rightFooterPicture: Excel.HeaderFooterPicture;

プロパティ値

Excel.HeaderFooterPicture

注釈

API セット: ExcelApiDesktop 1.1

rightHeader

ワークシートの右ヘッダー。 フォントの書式設定を適用したり、変数値を挿入したりするには、 https://msdn.microsoft.com/library/bb225426.aspx で指定した書式コードを使用します。

rightHeader: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.9

rightHeaderPicture

ヘッダーの右側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。

readonly rightHeaderPicture: Excel.HeaderFooterPicture;

プロパティ値

Excel.HeaderFooterPicture

注釈

API セット: ExcelApiDesktop 1.1

メソッドの詳細

load(options)

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

load(options?: Excel.Interfaces.HeaderFooterLoadOptions): Excel.HeaderFooter;

パラメーター

options

Excel.Interfaces.HeaderFooterLoadOptions

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

返品

Excel.HeaderFooter

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

返品

Excel.HeaderFooter

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

返品

Excel.HeaderFooter

set(properties, options)

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

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

パラメーター

properties

Excel.Interfaces.HeaderFooterUpdateData

メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。

options

OfficeExtension.UpdateOptions

プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

返品

void

set(properties)

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

set(properties: Excel.HeaderFooter): void;

パラメーター

properties

Excel.HeaderFooter

返品

void

toJSON()

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

toJSON(): Excel.Interfaces.HeaderFooterData;

返品

Excel.Interfaces.HeaderFooterData