Excel.BindingCollection class
Eine Sammlung aller Binding-Objekte, die Teil der Arbeitsmappe sind.
- 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. |
| count | Gibt die Anzahl der Bindungen in der Sammlung zurück. |
| items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Methoden
| add(range, binding |
Fügt eine neue Bindung an einen bestimmten Bereich hinzu. |
| add(range, binding |
Fügt eine neue Bindung an einen bestimmten Bereich hinzu. |
| add |
Fügt eine neue Bindung auf Grundlage eines benannten Elements in der Arbeitsmappe hinzu. Wenn das benannte Element auf mehrere Bereiche verweist, wird der |
| add |
Fügt eine neue Bindung auf Grundlage eines benannten Elements in der Arbeitsmappe hinzu. Wenn das benannte Element auf mehrere Bereiche verweist, wird der |
| add |
Fügt eine neue Bindung basierend auf der aktuellen Auswahl hinzu. Wenn die Auswahl über mehrere Bereiche verfügt, wird der |
| add |
Fügt eine neue Bindung basierend auf der aktuellen Auswahl hinzu. Wenn die Auswahl über mehrere Bereiche verfügt, wird der |
| get |
Ruft die Anzahl der Bindungen in der Sammlung ab. |
| get |
Ruft ein binding-Objekt anhand seiner ID ab. |
| get |
Ruft ein Binding-Objekt anhand seiner Position im Elementarray ab. |
| get |
Ruft ein binding-Objekt anhand seiner ID ab. Wenn das Bindungsobjekt nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen |
| 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 |
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
count
Gibt die Anzahl der Bindungen in der Sammlung zurück.
readonly count: number;Eigenschaftswert
number
Hinweise
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Excel.Binding[];Eigenschaftswert
Details zur Methode
add(range, bindingType, id)
Fügt eine neue Bindung an einen bestimmten Bereich hinzu.
add(range: Range | string, bindingType: Excel.BindingType, id: string): Excel.Binding;Parameter
- range
-
Excel.Range | string
Bereich für die Bindung. Kann ein Range Objekt oder eine Zeichenfolge sein. Eine Zeichenfolge muss die vollständige Adresse einschließlich des Blattnamens enthalten.
- bindingType
- Excel.BindingType
Typ der Bindung. Weitere Informationen finden Sie unter Excel.BindingType.
- id
-
string
Name der Bindung.
Gibt zurück
Hinweise
add(range, bindingTypeString, id)
Fügt eine neue Bindung an einen bestimmten Bereich hinzu.
add(range: Range | string, bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;Parameter
- range
-
Excel.Range | string
Bereich für die Bindung. Kann ein Range Objekt oder eine Zeichenfolge sein. Eine Zeichenfolge muss die vollständige Adresse einschließlich des Blattnamens enthalten.
- bindingTypeString
-
"Range" | "Table" | "Text"
Typ der Bindung. Weitere Informationen finden Sie unter Excel.BindingType.
- id
-
string
Name der Bindung.
Gibt zurück
Hinweise
addFromNamedItem(name, bindingType, id)
Fügt eine neue Bindung auf Grundlage eines benannten Elements in der Arbeitsmappe hinzu. Wenn das benannte Element auf mehrere Bereiche verweist, wird der InvalidReference Fehler zurückgegeben.
addFromNamedItem(name: string, bindingType: Excel.BindingType, id: string): Excel.Binding;Parameter
- name
-
string
Name, aus dem die Bindung erstellt wird.
- bindingType
- Excel.BindingType
Typ der Bindung. Weitere Informationen finden Sie unter Excel.BindingType.
- id
-
string
Name der Bindung.
Gibt zurück
Hinweise
addFromNamedItem(name, bindingTypeString, id)
Fügt eine neue Bindung auf Grundlage eines benannten Elements in der Arbeitsmappe hinzu. Wenn das benannte Element auf mehrere Bereiche verweist, wird der InvalidReference Fehler zurückgegeben.
addFromNamedItem(name: string, bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;Parameter
- name
-
string
Name, aus dem die Bindung erstellt wird.
- bindingTypeString
-
"Range" | "Table" | "Text"
Typ der Bindung. Weitere Informationen finden Sie unter Excel.BindingType.
- id
-
string
Name der Bindung.
Gibt zurück
Hinweise
addFromSelection(bindingType, id)
Fügt eine neue Bindung basierend auf der aktuellen Auswahl hinzu. Wenn die Auswahl über mehrere Bereiche verfügt, wird der InvalidReference Fehler zurückgegeben.
addFromSelection(bindingType: Excel.BindingType, id: string): Excel.Binding;Parameter
- bindingType
- Excel.BindingType
Typ der Bindung. Weitere Informationen finden Sie unter Excel.BindingType.
- id
-
string
Name der Bindung.
Gibt zurück
Hinweise
addFromSelection(bindingTypeString, id)
Fügt eine neue Bindung basierend auf der aktuellen Auswahl hinzu. Wenn die Auswahl über mehrere Bereiche verfügt, wird der InvalidReference Fehler zurückgegeben.
addFromSelection(bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;Parameter
- bindingTypeString
-
"Range" | "Table" | "Text"
Typ der Bindung. Weitere Informationen finden Sie unter Excel.BindingType.
- id
-
string
Name der Bindung.
Gibt zurück
Hinweise
getCount()
Ruft die Anzahl der Bindungen in der Sammlung ab.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
getItem(id)
Ruft ein binding-Objekt anhand seiner ID ab.
getItem(id: string): Excel.Binding;Parameter
- id
-
string
ID des abzurufenden Binding-Objekts.
Gibt zurück
Hinweise
Beispiele
async function onBindingDataChanged(eventArgs) {
await Excel.run(async (context) => {
// Highlight the table related to the binding in orange to indicate data has been changed.
context.workbook.bindings.getItem(eventArgs.binding.id).getTable().getDataBodyRange().format.fill.color = "Orange";
await context.sync();
console.log("The value in this table got changed!");
});
}
getItemAt(index)
Ruft ein Binding-Objekt anhand seiner Position im Elementarray ab.
getItemAt(index: number): Excel.Binding;Parameter
- index
-
number
Index-Wert des abzurufenden Objekts. Nullindiziert.
Gibt zurück
Hinweise
Beispiele
await Excel.run(async (context) => {
const lastPosition = context.workbook.bindings.count - 1;
const binding = context.workbook.bindings.getItemAt(lastPosition);
binding.load('type')
await context.sync();
console.log(binding.type);
});
getItemOrNullObject(id)
Ruft ein binding-Objekt anhand seiner ID ab. Wenn das Bindungsobjekt nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(id: string): Excel.Binding;Parameter
- id
-
string
ID des abzurufenden Binding-Objekts.
Gibt zurück
Hinweise
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.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection;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.BindingCollection;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 bindings = context.workbook.bindings;
bindings.load('items');
await context.sync();
for (let i = 0; i < bindings.items.length; i++) {
console.log(bindings.items[i].id);
}
});
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?: OfficeExtension.LoadOption): Excel.BindingCollection;Parameter
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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.BindingCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.BindingCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.
toJSON(): Excel.Interfaces.BindingCollectionData;Gibt zurück
Office Add-ins