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;