Office.Bindings interface

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

document: Document;

Eigenschaftswert

Office.Document

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

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

Parameter

itemName: string

Name des bindbaren Objekts im Dokument. Beispiel: Tabelle "MyExpenses" in Excel."

bindingType: Office.BindingType

Der Office.BindingType für die Daten. Die Methode gibt NULL zurück, wenn das ausgewählte Objekt nicht in den angegebenen Typ umgewandelt werden kann.

options: Office.AddBindingFromNamedItemOptions

Stellt Optionen zum Konfigurieren der erstellten Bindung bereit.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist das Binding-Objekt, das das angegebene benannte Element darstellt.

Gibt zurück

void

Hinweise

Anforderungssätze:

In Excel kann der itemName-Parameter 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 in der 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, um den Namen des Arbeitsblatts in den Namen der Tabelle im folgenden Format einzuschließen: "Sheet1! Tabelle1"

Für Word bezieht sich der itemName-Parameter auf die Title-Eigenschaft eines Rich Text-Inhaltssteuerelements. (Sie können keine anderen Inhaltssteuerelemente als das Rich-Text-Inhaltssteuerelement binden.)

Standardmäßig ist einem Inhaltssteuerelement kein Title-Wert 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 Title-Eigenschaftswert (Name) vorhanden sind und Sie versuchen, eine Bindung an eins dieser Inhaltssteuerelemente mit dieser Methode (durch Angabe des Namens als itemName-Parameter) zu binden, 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 == '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 == '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

itemName: string

Name des bindbaren Objekts im Dokument. Beispiel: Tabelle "MyExpenses" in Excel."

bindingType: Office.BindingType

Der Office.BindingType für die Daten. Die Methode gibt NULL zurück, wenn das ausgewählte Objekt nicht in den angegebenen Typ umgewandelt werden kann.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist das Binding-Objekt, das das angegebene benannte Element darstellt.

Gibt zurück

void

Hinweise

MatrixBindings, TableBindings, TextBindings

In Excel kann der itemName-Parameter 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 in der 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, um den Namen des Arbeitsblatts in den Namen der Tabelle im folgenden Format einzuschließen: "Sheet1! Tabelle1"

Für Word bezieht sich der itemName-Parameter auf die Title-Eigenschaft eines Rich Text-Inhaltssteuerelements. (Sie können keine anderen Inhaltssteuerelemente als das Rich-Text-Inhaltssteuerelement binden.)

Standardmäßig ist einem Inhaltssteuerelement kein Title-Wert 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 Title-Eigenschaftswert (Name) vorhanden sind und Sie versuchen, eine Bindung an eins dieser Inhaltssteuerelemente mit dieser Methode (durch Angabe des Namens als itemName-Parameter) zu binden, schlägt der Vorgang fehl.

Erstellen Sie eine Bindung, indem Sie den Benutzer auffordern, eine Auswahl für das Dokument vorzunehmen.

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

Parameter

bindingType: Office.BindingType

Gibt den Typ des Bindungsobjekts an, der erstellt werden soll. Erforderlich. Gibt NULL zurück, wenn das ausgewählte Objekt nicht in den angegebenen Typ umgewandelt werden kann.

options: Office.AddBindingFromPromptOptions

Stellt Optionen zum Konfigurieren der Eingabeaufforderung und Identifizieren der erstellten Bindung bereit.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist das Binding-Objekt, das die vom Benutzer angegebene Auswahl darstellt.

Gibt zurück

void

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 für das Dokument vorzunehmen.

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

Parameter

bindingType: Office.BindingType

Gibt den Typ des Bindungsobjekts an, der erstellt werden soll. Erforderlich. Gibt NULL zurück, wenn das ausgewählte Objekt nicht in den angegebenen Typ umgewandelt werden kann.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist das Binding-Objekt, das die vom Benutzer angegebene Auswahl darstellt.

Gibt zurück

void

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.

Erstellen Sie eine Bindung basierend auf der aktuellen Auswahl des Benutzers.

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

Parameter

bindingType: Office.BindingType

Gibt den Typ des Bindungsobjekts an, der erstellt werden soll. Erforderlich. Gibt NULL zurück, wenn das ausgewählte Objekt nicht in den angegebenen Typ umgewandelt werden kann.

options: Office.AddBindingFromSelectionOptions

Stellt Optionen zum Identifizieren der erstellten Bindung bereit.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist das Binding-Objekt, das die vom Benutzer angegebene Auswahl darstellt.

Gibt zurück

void

Hinweise

Anforderungssätze:

Fügt der Bindings-Auflistung den angegebenen Bindungsobjekttyp hinzu, der mit der angegebenen ID identifiziert wird.

Hinweis Wenn Sie in Excel die addFromSelectionAsync-Methode aufrufen, die die Binding.id einer vorhandenen Bindung übergibt, wird binding.type dieser Bindung verwendet, und ihr Typ kann nicht durch Angabe eines anderen Werts für den bindingType-Parameter geändert werden. 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; 
}

Erstellen Sie eine Bindung basierend auf der aktuellen Auswahl des Benutzers.

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

Parameter

bindingType: Office.BindingType

Gibt den Typ des Bindungsobjekts an, der erstellt werden soll. Erforderlich. Gibt NULL zurück, wenn das ausgewählte Objekt nicht in den angegebenen Typ umgewandelt werden kann.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist das Binding-Objekt, das die vom Benutzer angegebene Auswahl darstellt.

Gibt zurück

void

Hinweise

Anforderungssätze:

Fügt der Bindings-Auflistung den angegebenen Bindungsobjekttyp hinzu, der mit der angegebenen ID identifiziert wird.

Hinweis Wenn Sie in Excel die addFromSelectionAsync-Methode aufrufen, die die Binding.id einer vorhandenen Bindung übergibt, wird binding.type dieser Bindung verwendet, und ihr Typ kann nicht durch Angabe eines anderen Werts für den bindingType-Parameter geändert werden. 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

options: Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback: (result: Office.AsyncResult<Office.Binding[]>) => void

Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist ein Array, das jede Bindung enthält, die für das Bindings-Objekt erstellt wurde, auf das verwiesen wird.

Gibt zurück

void

Hinweise

Anforderungssätze:

Ruft alle vorher erstellten Bindungen ab.

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

Parameter

callback: (result: Office.AsyncResult<Office.Binding[]>) => void

Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist ein Array, das jede Bindung enthält, die für das Bindings-Objekt erstellt wurde, auf das verwiesen wird.

Gibt zurück

void

Hinweise

Anforderungssätze:

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

id: string

Gibt den eindeutigen Namen des Bindungsobjekts an. Erforderlich.

options: Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value Eigenschaft des Ergebnisses ist das Binding-Objekt, das durch die ID im Aufruf angegeben wird.

Gibt zurück

void

Hinweise

Anforderungssätze:

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

id: string

Gibt den eindeutigen Namen des Bindungsobjekts an. Erforderlich.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value Eigenschaft des Ergebnisses ist das Binding-Objekt, das durch die ID im Aufruf angegeben wird.

Gibt zurück

void

Hinweise

Anforderungssätze:

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

id: string

Gibt den eindeutigen Namen an, der zum Identifizieren des Objekts verwendet werden soll. Erforderlich.

options: Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback: (result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Anforderungssätze:

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

id: string

Gibt den eindeutigen Namen an, der zum Identifizieren des Objekts verwendet werden soll. Erforderlich.

callback: (result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Anforderungssätze:

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

addFromNamedItemAsync(itemName, bindingType, options, callback)	Erstellt eine Bindung für ein benanntes Objekt im Dokument.
addFromNamedItemAsync(itemName, bindingType, callback)	Erstellt eine Bindung für ein benanntes Objekt im Dokument.
addFromPromptAsync(bindingType, options, callback)	Erstellen Sie eine Bindung, indem Sie den Benutzer auffordern, eine Auswahl für das Dokument vorzunehmen.
addFromPromptAsync(bindingType, callback)	Erstellen Sie eine Bindung, indem Sie den Benutzer auffordern, eine Auswahl für das Dokument vorzunehmen.
addFromSelectionAsync(bindingType, options, callback)	Erstellen Sie eine Bindung basierend auf der aktuellen Auswahl des Benutzers.
addFromSelectionAsync(bindingType, callback)	Erstellen Sie eine Bindung basierend auf der aktuellen Auswahl des Benutzers.
getAllAsync(options, callback)	Ruft alle vorher erstellten Bindungen ab.
getAllAsync(callback)	Ruft alle vorher erstellten Bindungen ab.
getByIdAsync(id, options, callback)	Ruft eine Bindung basierend auf ihrem Namen ab.
getByIdAsync(id, callback)	Ruft eine Bindung basierend auf ihrem Namen ab.
releaseByIdAsync(id, options, callback)	Entfernt die Bindung aus dem Dokument.
releaseByIdAsync(id, callback)	Entfernt die Bindung aus dem Dokument.

Eigenschaften

Methoden

Details zur Eigenschaft

document

Eigenschaftswert

Details zur Methode

addFromNamedItemAsync(itemName, bindingType, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

addFromNamedItemAsync(itemName, bindingType, callback)

Parameter

Gibt zurück

Hinweise

addFromPromptAsync(bindingType, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

addFromPromptAsync(bindingType, callback)

Parameter

Gibt zurück

Hinweise

addFromSelectionAsync(bindingType, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

addFromSelectionAsync(bindingType, callback)

Parameter

Gibt zurück

Hinweise

getAllAsync(options, callback)

Parameter

Gibt zurück

Hinweise

getAllAsync(callback)

Parameter

Gibt zurück

Hinweise

Beispiele

getByIdAsync(id, options, callback)

Parameter

Gibt zurück

Hinweise

getByIdAsync(id, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

releaseByIdAsync(id, options, callback)

Parameter

Gibt zurück

Hinweise

releaseByIdAsync(id, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

Feedback

Zusätzliche Ressourcen