Excel.LinkedWorkbookCollection class
リンクされたブック オブジェクトのコレクションを表します。
- Extends
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
| workbook |
ブック リンクの更新モードを表します。 モードは、ブックに存在するすべてのブック リンクで同じです。 |
メソッド
| break |
リンクされているブックへのすべてのリンクを解除します。 リンクが解除されると、ブックのリンクを参照するすべての数式が完全に削除され、最後に取得された値に置き換えられます。 |
| get |
リンクされたブックに関する情報をその URL で取得します。 |
| get |
リンクされたブックに関する情報をその URL で取得します。 ブックが存在しない場合、このメソッドは |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| refresh |
すべてのブック リンクを更新する要求を行います。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
workbookLinksRefreshMode
ブック リンクの更新モードを表します。 モードは、ブックに存在するすべてのブック リンクで同じです。
workbookLinksRefreshMode: Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic";プロパティ値
Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic"
注釈
メソッドの詳細
breakAllLinks()
リンクされているブックへのすべてのリンクを解除します。 リンクが解除されると、ブックのリンクを参照するすべての数式が完全に削除され、最後に取得された値に置き換えられます。
breakAllLinks(): void;返品
void
注釈
getItem(key)
リンクされたブックに関する情報をその URL で取得します。
getItem(key: string): Excel.LinkedWorkbook;パラメーター
- key
-
string
リンクされたブックの URL。
返品
指定された URL にリンクされたブック。
注釈
getItemOrNullObject(key)
リンクされたブックに関する情報をその URL で取得します。 ブックが存在しない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
getItemOrNullObject(key: string): Excel.LinkedWorkbook;パラメーター
- key
-
string
リンクされたブックの URL。
返品
指定された URL を持つリンクされたブック。
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedWorkbookCollection;パラメーター
- options
-
Excel.Interfaces.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.LinkedWorkbookCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedWorkbookCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
refreshAll()
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.LinkedWorkbookCollection オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.LinkedWorkbookCollectionData として型指定された) を返します。
toJSON(): Excel.Interfaces.LinkedWorkbookCollectionData;