Excel.Binding class
Stellt eine Office.js-Bindung dar, die in der Arbeitsmappe definiert wird.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| id | Stellt den Bindungsbezeichner dar. |
| type | Gibt den Typ der Bindung an. Weitere Informationen finden Sie unter |
Methoden
| delete() | Löscht die Bindung. |
| get |
Gibt den durch die Bindung dargestellten Bereich zurück. Löst einen Fehler aus, wenn die Bindung nicht den richtigen Typ aufweist. |
| get |
Gibt die durch die Bindung dargestellte Tabelle zurück. Löst einen Fehler aus, wenn die Bindung nicht den richtigen Typ aufweist. |
| get |
Gibt den durch die Bindung dargestellten Text zurück. Löst einen Fehler aus, wenn die Bindung nicht den richtigen Typ aufweist. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| toJSON() | Überschreibt die JavaScript-Methode |
Ereignisse
| on |
Tritt ein, wenn die Daten oder die Formatierung in der Datenbindung geändert werden. |
| on |
Tritt ein, wenn der ausgewählte Inhalt in der Bindung geändert wird.
Hinweis*: Wenn mehrere, nicht zusammenhängende Zellen ausgewählt sind, |
Details zur Eigenschaft
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
id
Stellt den Bindungsbezeichner dar.
readonly id: string;Eigenschaftswert
string
Hinweise
type
Gibt den Typ der Bindung an. Weitere Informationen finden Sie unter Excel.BindingType .
readonly type: Excel.BindingType | "Range" | "Table" | "Text";Eigenschaftswert
Excel.BindingType | "Range" | "Table" | "Text"
Hinweise
Details zur Methode
delete()
getRange()
Gibt den durch die Bindung dargestellten Bereich zurück. Löst einen Fehler aus, wenn die Bindung nicht den richtigen Typ aufweist.
getRange(): Excel.Range;Gibt zurück
Hinweise
Beispiele
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()
Gibt die durch die Bindung dargestellte Tabelle zurück. Löst einen Fehler aus, wenn die Bindung nicht den richtigen Typ aufweist.
getTable(): Excel.Table;Gibt zurück
Hinweise
Beispiele
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()
Gibt den durch die Bindung dargestellten Text zurück. Löst einen Fehler aus, wenn die Bindung nicht den richtigen Typ aufweist.
getText(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
Beispiele
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)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Excel.Interfaces.BindingLoadOptions): Excel.Binding;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Excel.Binding;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
Beispiele
await Excel.run(async (context) => {
const binding = context.workbook.bindings.getItemAt(0);
binding.load('type');
await context.sync();
console.log(binding.type);
});
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Binding;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Binding-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.BindingData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.BindingData;Gibt zurück
Details zum Ereignis
onDataChanged
Tritt ein, wenn die Daten oder die Formatierung in der Datenbindung geändert werden.
readonly onDataChanged: OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>;Ereignistyp
Hinweise
Beispiele
// 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
Tritt ein, wenn der ausgewählte Inhalt in der Bindung geändert wird.
Hinweis*: Wenn mehrere, nicht zusammenhängende Zellen ausgewählt sind, Binding.onSelectionChanged werden nur Zeilen- und Spalteninformationen für eine Auswahl gemeldet. Wird Worksheet.onSelectionChanged für mehrere ausgewählte Bereiche verwendet.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>;Ereignistyp
Hinweise
Office Add-ins