Excel.LinkedWorkbookCollection class
リンクされたブック オブジェクトのコレクションを表します。
- Extends
注釈
[ API セット: ExcelApiOnline 1.1 ]
プロパティ
| 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;戻り値
Office Add-ins