Excel.Binding class
ブックで定義されている Office.js のバインディングを表します。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| id | バインド識別子を表します。 |
| type | バインドの型を返します。 詳細は「 |
メソッド
| delete() | バインドを削除します。 |
| get |
バインディングによって表される範囲を返します。 バインドが正しい型でない場合は、エラーがスローされます。 |
| get |
バインドによって表されるテーブルを返します。 バインドが正しい型でない場合は、エラーがスローされます。 |
| get |
バインドによって表されるテキストを返します。 バインドが正しい型でない場合は、エラーがスローされます。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
イベント
| on |
バインド内でデータまたは書式設定が変更されるときに発生します。 |
| on |
バインドで選択したコンテンツが変更されたときに発生します。
注*: 複数の不明確なセルが選択されている場合、 |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
id
type
バインドの型を返します。 詳細は「Excel.BindingType」をご覧ください。
readonly type: Excel.BindingType | "Range" | "Table" | "Text";プロパティ値
Excel.BindingType | "Range" | "Table" | "Text"
注釈
メソッドの詳細
delete()
getRange()
バインディングによって表される範囲を返します。 バインドが正しい型でない場合は、エラーがスローされます。
getRange(): Excel.Range;戻り値
注釈
例
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
const range = binding.getRange();
range.load('cellCount');
await context.sync();
console.log(range.cellCount);
});
getTable()
バインドによって表されるテーブルを返します。 バインドが正しい型でない場合は、エラーがスローされます。
getTable(): Excel.Table;戻り値
注釈
例
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
const table = binding.getTable();
table.load('name');
await context.sync();
console.log(table.name);
});
getText()
バインドによって表されるテキストを返します。 バインドが正しい型でない場合は、エラーがスローされます。
getText(): OfficeExtension.ClientResult<string>;戻り値
OfficeExtension.ClientResult<string>
注釈
例
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
const text = binding.getText();
binding.load('text');
await context.sync();
console.log(text);
});
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.BindingLoadOptions): Excel.Binding;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.Binding;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
binding.load('type');
await context.sync();
console.log(binding.type);
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Binding;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Binding オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.BindingData として型指定) を返します。
toJSON(): Excel.Interfaces.BindingData;戻り値
イベントの詳細
onDataChanged
バインド内でデータまたは書式設定が変更されるときに発生します。
readonly onDataChanged: OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>;イベントの種類
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/data-changed.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const salesTable = sheet.tables.getItem("SalesTable");
const salesByQuarterBinding = context.workbook.bindings.add(salesTable.getRange(), "Table", "SalesByQuarter");
salesByQuarterBinding.onDataChanged.add(onSalesDataChanged);
console.log("The data changed handler is registered.");
await context.sync();
});
onSelectionChanged
バインドで選択したコンテンツが変更されたときに発生します。
注*: 複数の不明確なセルが選択されている場合、 Binding.onSelectionChanged は、1 つの選択に関する行と列の情報のみを報告します。 選択した複数の範囲に Worksheet.onSelectionChanged を使用します。
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>;イベントの種類
注釈
Office Add-ins