Office.Bindings interface

Ruft ein Office.Document-Objekt ab, das das mit diesem Satz von Bindungen verbundene Dokument darstellt.

document: Document;

Eigenschaftswert

Erstellt eine Bindung für ein benanntes Objekt im Dokument.

addFromNamedItemAsync(itemName: string, bindingType: BindingType, options?: AddBindingFromNamedItemOptions, callback?: (result: AsyncResult<Binding>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssätze:

• MatrixBindings

• TableBindings

• TextBindings

In Excel kann der Parameter itemName auf einen benannten Bereich oder eine Tabelle verweisen.

Standardmäßig wird in Excel der ersten hinzugefügten Tabelle der Name "Tabelle1" und der zweiten hinzugefügten Tabelle der Name "Tabelle2" zugewiesen und so weiter. Um einer Tabelle in der Excel-Benutzeroberfläche einen aussagekräftigen Namen zuzuweisen, verwenden Sie die Eigenschaft Tabellenname im Abschnitt Tabellentools | Registerkarte "Entwurf" des Menübands.

Hinweis: Wenn Sie in Excel eine Tabelle als benanntes Element angeben, müssen Sie den Namen vollständig qualifizieren, damit der Arbeitsblattname in den Namen der Tabelle im folgenden Format aufgenommen wird: "Tabelle1! Tabelle1"

In Word bezieht sich der Parameter itemName auf die Title-Eigenschaft eines Rich-Text-Inhaltssteuerelements. (Sie können keine Bindung an andere Inhaltssteuerelemente als das Rich-Text-Inhaltssteuerelement herstellen).

Standardmäßig ist einem Inhaltssteuerelement kein Titelwert zugewiesen. To assign a meaningful name in the Word UI, after inserting a Rich Text content control from the Controls group on the Developer tab of the ribbon, use the Properties command in the Controls group to display the Content Control Properties dialog box. Then set the Title property of the content control to the name you want to reference from your code.

Hinweis: Wenn in Word mehrere Rich-Text-Inhaltssteuerelemente mit demselben Titel-Eigenschaftswert (Name) vorhanden sind und Sie versuchen, mit dieser Methode eine Bindung an eines dieser Inhaltssteuerelemente herzustellen (indem Sie den Namen als itemName-Parameter angeben), schlägt der Vorgang fehl.

Beispiele

// The following example adds a binding to the myRange named item in Excel as a "matrix" binding,
// and assigns the binding's id as myMatrix.
function bindNamedItem() {
    Office.context.document.bindings.addFromNamedItemAsync(
        "myRange", "matrix", {id:'myMatrix'}, function (result) {
        if (result.status === Office.AsyncResultStatus.Succeeded) {
            write('Added new binding with type: ' + result.value.type + ' and id: ' + result.value.id);
        } else {
            write('Error: ' + result.error.message);
        }
    });
}

// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

// The following example adds a binding to the Table1 named item in Excel as a "table" binding,
// and assigns the binding's id as myTable.
function bindNamedItem() {
    Office.context.document.bindings.addFromNamedItemAsync(
        "Table1", "table", {id:'myTable'}, function (result) {
        if (result.status === Office.AsyncResultStatus.Succeeded) {
            write('Added new binding with type: ' + result.value.type + ' and id: ' + result.value.id);
        } else {
            write('Error: ' + result.error.message);
        }
    });
}

// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

// The following example creates a text binding in Word to a rich text content control named "FirstName",
// assigns the id "firstName", and then displays that information.
function bindContentControl() {
    Office.context.document.bindings.addFromNamedItemAsync('FirstName', 
        Office.BindingType.Text, {id:'firstName'},
        function (result) {
            if (result.status === Office.AsyncResultStatus.Succeeded) {
                write('Control bound. Binding.id: '
                    + result.value.id + ' Binding.type: ' + result.value.type);
            } else {
                write('Error: ' + result.error.message);
            }
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

Erstellt eine Bindung für ein benanntes Objekt im Dokument.

addFromNamedItemAsync(itemName: string, bindingType: BindingType, callback?: (result: AsyncResult<Binding>) => void): void;

Parameter

Gibt zurück

Hinweise

MatrixBindings, TableBindings, TextBindings

In Excel kann der Parameter itemName auf einen benannten Bereich oder eine Tabelle verweisen.

Standardmäßig wird in Excel der ersten hinzugefügten Tabelle der Name "Tabelle1" und der zweiten hinzugefügten Tabelle der Name "Tabelle2" zugewiesen und so weiter. Um einer Tabelle in der Excel-Benutzeroberfläche einen aussagekräftigen Namen zuzuweisen, verwenden Sie die Eigenschaft Tabellenname im Abschnitt Tabellentools | Registerkarte "Entwurf" des Menübands.

Hinweis: Wenn Sie in Excel eine Tabelle als benanntes Element angeben, müssen Sie den Namen vollständig qualifizieren, damit der Arbeitsblattname in den Namen der Tabelle im folgenden Format aufgenommen wird: "Tabelle1! Tabelle1"

In Word bezieht sich der Parameter itemName auf die Title-Eigenschaft eines Rich-Text-Inhaltssteuerelements. (Sie können keine Bindung an andere Inhaltssteuerelemente als das Rich-Text-Inhaltssteuerelement herstellen).

Standardmäßig ist einem Inhaltssteuerelement kein Titelwert zugewiesen. To assign a meaningful name in the Word UI, after inserting a Rich Text content control from the Controls group on the Developer tab of the ribbon, use the Properties command in the Controls group to display the Content Control Properties dialog box. Then set the Title property of the content control to the name you want to reference from your code.

Hinweis: Wenn in Word mehrere Rich-Text-Inhaltssteuerelemente mit demselben Titel-Eigenschaftswert (Name) vorhanden sind und Sie versuchen, mit dieser Methode eine Bindung an eines dieser Inhaltssteuerelemente herzustellen (indem Sie den Namen als itemName-Parameter angeben), schlägt der Vorgang fehl.

Erstellen Sie eine Bindung, indem Sie den Benutzer auffordern, eine Auswahl im Dokument zu treffen.

addFromPromptAsync(bindingType: BindingType, options?: AddBindingFromPromptOptions, callback?: (result: AsyncResult<Binding>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssatz: Nicht in einem Satz

Fügt der Bindings-Auflistung ein Bindungsobjekt des angegebenen Typs hinzu, das mit der angegebenen ID identifiziert wird. Bei der Methode tritt ein Fehler auf, wenn die angegebene Auswahl nicht gefunden werden kann.

Beispiele

function addBindingFromPrompt() {
    Office.context.document.bindings.addFromPromptAsync(
        Office.BindingType.Text, 
        { id: 'MyBinding', promptText: 'Select text to bind to.' },
        function (asyncResult) {
            write('Added new binding with type: ' + asyncResult.value.type + ' and id: ' + asyncResult.value.id);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

Erstellen Sie eine Bindung, indem Sie den Benutzer auffordern, eine Auswahl im Dokument zu treffen.

addFromPromptAsync(bindingType: BindingType, callback?: (result: AsyncResult<Binding>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssatz: Nicht in einem Satz

Fügt der Bindings-Auflistung ein Bindungsobjekt des angegebenen Typs hinzu, das mit der angegebenen ID identifiziert wird. Bei der Methode tritt ein Fehler auf, wenn die angegebene Auswahl nicht gefunden werden kann.

Eine Bindung basierend auf der aktuellen Auswahl des Benutzers erstellen.

addFromSelectionAsync(bindingType: BindingType, options?: AddBindingFromSelectionOptions, callback?: (result: AsyncResult<Binding>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssätze:

• MatrixBindings

• TableBindings

• TextBindings

Fügt den angegebenen Typ von Bindungsobjekt der Bindings-Auflistung hinzu, die mit der angegebenen ID identifiziert wird.

Hinweis Wenn Sie in Excel die addFromSelectionAsync-Methode aufrufen, die die Binding.id einer vorhandenen Bindung übergibt, wird der Binding.type dieser Bindung verwendet, und sein Typ kann nicht geändert werden, indem ein anderer Wert für den BindingType-Parameter angegeben wird. Wenn Sie eine vorhandene ID verwenden und den BindingType ändern müssen, rufen Sie zuerst die Bindings.releaseByIdAsync-Methode auf, um die Bindung freizugeben, und rufen Sie dann die addFromSelectionAsync-Methode auf, um die Bindung mit einem neuen Typ wiederherzustellen.

Beispiele

function addBindingFromSelection() {
    Office.context.document.bindings.addFromSelectionAsync(Office.BindingType.Text, { id: 'MyBinding' }, 
        function (asyncResult) {
            write('Added new binding with type: ' + asyncResult.value.type + ' and id: ' + asyncResult.value.id);
        }
    );
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

Eine Bindung basierend auf der aktuellen Auswahl des Benutzers erstellen.

addFromSelectionAsync(bindingType: BindingType, callback?: (result: AsyncResult<Binding>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssätze:

• MatrixBindings

• TableBindings

• TextBindings

Fügt den angegebenen Typ von Bindungsobjekt der Bindings-Auflistung hinzu, die mit der angegebenen ID identifiziert wird.

Hinweis Wenn Sie in Excel die addFromSelectionAsync-Methode aufrufen, die die Binding.id einer vorhandenen Bindung übergibt, wird der Binding.type dieser Bindung verwendet, und sein Typ kann nicht geändert werden, indem ein anderer Wert für den BindingType-Parameter angegeben wird. Wenn Sie eine vorhandene ID verwenden und den BindingType ändern müssen, rufen Sie zuerst die Bindings.releaseByIdAsync-Methode auf, um die Bindung freizugeben, und rufen Sie dann die addFromSelectionAsync-Methode auf, um die Bindung mit einem neuen Typ wiederherzustellen.

Ruft alle vorher erstellten Bindungen ab.

getAllAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Binding[]>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssätze:

• MatrixBindings

• TableBindings

• TextBindings

Ruft alle vorher erstellten Bindungen ab.

getAllAsync(callback?: (result: AsyncResult<Binding[]>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssätze:

• MatrixBindings

• TableBindings

• TextBindings

Beispiele

function displayAllBindingNames() {
    Office.context.document.bindings.getAllAsync(function (asyncResult) {
        let bindingString = '';
        for (let i in asyncResult.value) {
            bindingString += asyncResult.value[i].id + '\n';
        }
        write('Existing bindings: ' + bindingString);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

Ruft eine Bindung basierend auf ihrem Namen ab.

getByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Binding>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssätze:

• MatrixBindings

• TableBindings

• TextBindings

Schlägt fehl, wenn die angegebene ID nicht vorhanden ist.

Ruft eine Bindung basierend auf ihrem Namen ab.

getByIdAsync(id: string, callback?: (result: AsyncResult<Binding>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssätze:

• MatrixBindings

• TableBindings

• TextBindings

Schlägt fehl, wenn die angegebene ID nicht vorhanden ist.

Beispiele

function displayBindingType() {
    Office.context.document.bindings.getByIdAsync('MyBinding', function (asyncResult) {
        write('Retrieved binding with type: ' + asyncResult.value.type + ' and id: ' + asyncResult.value.id);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

Entfernt die Bindung aus dem Dokument

releaseByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssätze:

• MatrixBindings

• TableBindings

• TextBindings

Schlägt fehl, wenn die angegebene ID nicht vorhanden ist.

Entfernt die Bindung aus dem Dokument

releaseByIdAsync(id: string, callback?: (result: AsyncResult<void>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssätze:

• MatrixBindings

• TableBindings

• TextBindings

Schlägt fehl, wenn die angegebene ID nicht vorhanden ist.

Beispiele

Office.context.document.bindings.releaseByIdAsync("MyBinding", function (asyncResult) { 
    write("Released MyBinding!"); 
}); 
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}