Excel.Binding class

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Stellt den Bindungsbezeichner dar.

readonly id: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Gibt den Typ der Bindung an. Weitere Informationen finden Sie unter Excel.BindingType .

readonly type: Excel.BindingType | "Range" | "Table" | "Text";

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

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

[ API-Satz: ExcelApi 1.1 ]

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);
});

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

[ API-Satz: ExcelApi 1.1 ]

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);
});

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

Hinweise

[ API-Satz: ExcelApi 1.1 ]

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);
});

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

Gibt zurück

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

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);
});

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

Gibt zurück

Ü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

Tritt ein, wenn die Daten oder die Formatierung in der Datenbindung geändert werden.

readonly onDataChanged: OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>;

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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();
});

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

[ API-Satz: ExcelApi 1.2 ]