Excel.LinkedWorkbook class

パッケージ:

excel

リンクされたブックに関する情報が含まれます。 ブックに別のブック内のデータを指すリンクがある場合、2 番目のブックは最初のブックにリンクされます。 このシナリオでは、2 つ目のブックは "リンクされたブック" と呼ばれます。

Extends

OfficeExtension.ClientObject

注釈

[ API セット: ExcelApiOnline 1.1 ]

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
id	リンクされたブックを指す元の URL。 これは、コレクション内のすべてのリンクされたブックで一意です。

メソッド

breakLinks()	リンクされたブックを指すリンクを解除するように要求します。 数式内のリンクは、フェッチされた最新のデータに置き換えられます。 現在の LinkedWorkbook オブジェクトが無効になり、 から LinkedWorkbookCollection削除されます。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
refresh()	リンクされたブックから取得したデータを更新するように要求します。
toJSON()	API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Excel.LinkedWorkbook オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.LinkedWorkbookData型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

id

リンクされたブックを指す元の URL。 これは、コレクション内のすべてのリンクされたブックで一意です。

readonly id: string;

プロパティ値

string

注釈

[ API セット: ExcelApiOnline 1.1 ]

メソッドの詳細

breakLinks()

リンクされたブックを指すリンクを解除するように要求します。 数式内のリンクは、フェッチされた最新のデータに置き換えられます。 現在の LinkedWorkbook オブジェクトが無効になり、 から LinkedWorkbookCollection削除されます。

breakLinks(): void;

戻り値

void

注釈

[ API セット: ExcelApiOnline 1.1 ]

load(options)

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

load(options?: Excel.Interfaces.LinkedWorkbookLoadOptions): Excel.LinkedWorkbook;

パラメーター

options

Excel.Interfaces.LinkedWorkbookLoadOptions

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

戻り値

Excel.LinkedWorkbook

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Excel.LinkedWorkbook

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

Excel.LinkedWorkbook

refresh()

リンクされたブックから取得したデータを更新するように要求します。

refresh(): void;

戻り値

void

注釈

[ API セット: ExcelApiOnline 1.1 ]

toJSON()

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

toJSON(): Excel.Interfaces.LinkedWorkbookData;

戻り値

Excel.Interfaces.LinkedWorkbookData