次の方法で共有

Excel.HeaderFooter class

  • リファレンス
パッケージ:
excel
Extends
OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.9 ]

プロパティ

centerFooter

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

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

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

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

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

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

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

メソッド

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 ]

centerHeader

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

centerHeader: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.9 ]

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

leftFooter

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

leftFooter: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.9 ]

leftHeader

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

leftHeader: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.9 ]

rightFooter

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

rightFooter: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.9 ]

rightHeader

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

rightHeader: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.9 ]

メソッドの詳細

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

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

戻り値

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