Excel.LinkedWorkbook class
リンクされたブックに関する情報が含まれます。 ブックに別のブック内のデータを指すリンクがある場合、2 番目のブックは最初のブックにリンクされます。 このシナリオでは、2 つ目のブックは "リンクされたブック" と呼ばれます。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| id | リンクされたブックを指す元の URL。 これは、コレクション内のすべてのリンクされたブックで一意です。 |
メソッド
| break |
リンクされたブックを指すリンクを解除するように要求します。 数式内のリンクは、フェッチされた最新のデータに置き換えられます。 現在の |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| refresh() | リンクされたブックから取得したデータを更新するように要求します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
id
リンクされたブックを指す元の URL。 これは、コレクション内のすべてのリンクされたブックで一意です。
readonly id: string;プロパティ値
string
注釈
メソッドの詳細
breakLinks()
リンクされたブックを指すリンクを解除するように要求します。 数式内のリンクは、フェッチされた最新のデータに置き換えられます。 現在の LinkedWorkbook オブジェクトは無効になり、 LinkedWorkbookCollectionから削除されます。
breakLinks(): void;戻り値
void
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.LinkedWorkbookLoadOptions): Excel.LinkedWorkbook;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.LinkedWorkbook;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.LinkedWorkbook;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
refresh()
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.LinkedWorkbook オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.LinkedWorkbookData として型指定) を返します。
toJSON(): Excel.Interfaces.LinkedWorkbookData;