Office.Binding interface

Obtenir l’objet Document associé à la reliure.

document: Office.Document;

Valeur de propriété

Exemples

Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
    write(asyncResult.value.document.url);
});

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

Chaîne qui identifie de manière unique cette liaison parmi les liaisons du même objet Office.Document .

id: string;

Valeur de propriété

Exemples

Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
    write(asyncResult.value.id);
});

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

Obtient le type de la liaison.

type: Office.BindingType;

Valeur de propriété

Exemples

Office.context.document.bindings.getByIdAsync("MyBinding", function (asyncResult) { 
    write(asyncResult.value.type); 
}) 

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

Ajoute un gestionnaire d’événements à l’objet pour l’Office.EventType spécifié. Les types d’événements pris en charge sont Office.EventType.BindingDataChangedOffice.EventType.BindingSelectionChangedet .

addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Jeu de conditions préalables : BindingEvents

Vous pouvez ajouter plusieurs gestionnaires d’événements pour le type d’événement spécifié tant que le nom de chaque fonction de gestionnaire d’événements est unique.

Ajoute un gestionnaire d’événements à l’objet pour l’Office.EventType spécifié. Les types d’événements pris en charge sont Office.EventType.BindingDataChangedOffice.EventType.BindingSelectionChangedet .

addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Jeu de conditions préalables : BindingEvents

Vous pouvez ajouter plusieurs gestionnaires d’événements pour le type d’événement spécifié tant que le nom de chaque fonction de gestionnaire d’événements est unique.

Exemples

// The following code sample calls the select function of the Office object to access the binding
// with ID "MyBinding", and then calls the addHandlerAsync method to add a handler function 
// for the bindingDataChanged event of that binding.
function addEventHandlerToBinding() {
    Office.select("bindings#MyBinding").addHandlerAsync(
        Office.EventType.BindingDataChanged, onBindingDataChanged);
}

function onBindingDataChanged(eventArgs) {
    write("Data has changed in binding: " + eventArgs.binding.id);
}

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

// To add an event handler for the BindingSelectionChanged event of a binding, 
// use the addHandlerAsync method of the Binding object.
// The event handler receives an argument of type BindingSelectionChangedEventArgs.
function addEventHandlerToBinding() {
    Office.select("bindings#MyBinding").addHandlerAsync(
        Office.EventType.BindingSelectionChanged, onBindingSelectionChanged);
}

function onBindingSelectionChanged(eventArgs) {
    write(eventArgs.binding.id + " has been selected.");
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

Retourne les données contenues dans la liaison.

getDataAsync<T>(options?: GetBindingDataOptions, callback?: (result: AsyncResult<T>) => void): void;

Paramètres

Retours

Remarques

Ensembles de conditions requises :

• HtmlCoercion (lors de l’utilisation de Office.CoercionType.Html)

• MatrixBindings

• MatrixCoercion (lors de l’utilisation de Office.CoercionType.Matrix)

• OoxmlCoercion (lors de l’utilisation de Office.CoercionType.Ooxml)

• TableBindings

• TableCoercion (lors de l’utilisation de Office.CoercionType.Table)

• TextBindings

• TextCoercion (lors de l’utilisation de Office.CoercionType.Text)

Lorsqu’elle est appelée à partir d’un MatrixBinding ou d’un TableBinding, la méthode getDataAsync retourne un sous-ensemble des valeurs liées si les paramètres facultatifs startRow, startColumn, rowCount et columnCount sont spécifiés (et qu’ils spécifient une plage contiguë et valide).

Retourne les données contenues dans la liaison.

getDataAsync<T>(callback?: (result: AsyncResult<T>) => void): void;

Paramètres

Retours

Remarques

Ensembles de conditions requises :

• HtmlCoercion (lors de l’utilisation de Office.CoercionType.Html)

• MatrixBindings

• MatrixCoercion (lors de l’utilisation de Office.CoercionType.Matrix)

• OoxmlCoercion (lors de l’utilisation de Office.CoercionType.Ooxml)

• TableBindings

• TableCoercion (lors de l’utilisation de Office.CoercionType.Table)

• TextBindings

• TextCoercion (lors de l’utilisation de Office.CoercionType.Text)

Lorsqu’elle est appelée à partir d’un MatrixBinding ou d’un TableBinding, la méthode getDataAsync retourne un sous-ensemble des valeurs liées si les paramètres facultatifs startRow, startColumn, rowCount et columnCount sont spécifiés (et qu’ils spécifient une plage contiguë et valide).

Exemples

function showBindingData() {
    Office.select("bindings#MyBinding").getDataAsync(function (asyncResult) {
        write(asyncResult.value)
    });
}

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

// There is an important difference in behavior between using the "table" and "matrix" coercionType with the
// Binding.getDataAsync method, with respect to data formatted with header rows, as shown in the following
// two examples. These code examples show event handler functions for the Binding.SelectionChanged event.

// If you specify the "table" coercionType, the TableData.rows property ( result.value.rows in the following
// code example) returns an array that contains only the body rows of the table. So, its 0th row will be the
// first non-header row in the table.
function selectionChanged(evtArgs) { 
    Office.select("bindings#TableTranslate").getDataAsync(
        { coercionType: 'table', 
          startRow: evtArgs.startRow, 
          startCol: 0, 
          rowCount: 1, 
          columnCount: 1 },  
        function (result) { 
            if (result.status === Office.AsyncResultStatus.Succeeded) {
                write("Image to find: " + result.value.rows[0][0]); 
            } 
            else {
                write(result.error.message);
            }
    }); 
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

// However, if you specify the "matrix" coercionType, result.value in the following code example returns an array
// that contains the table header in the 0th row. If the table header contains multiple rows, then these are all
// included in the result.value matrix as separate rows before the table body rows are included.
function selectionChanged(evtArgs) { 
    Office.select("bindings#TableTranslate").getDataAsync(
        { coercionType: 'matrix', 
          startRow: evtArgs.startRow, 
          startCol: 0, 
          rowCount: 1, 
          columnCount: 1 },  
        function (result) { 
            if (result.status === Office.AsyncResultStatus.Succeeded) {
                write("Image to find: " + result.value[1][0]); 
            } 
            else {
                write(result.error.message);
            }
    }); 
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

Supprime le gestionnaire spécifié de la liaison pour le type d’événement spécifié.

removeHandlerAsync(eventType: Office.EventType, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Jeu de conditions préalables : BindingEvents

Supprime le gestionnaire spécifié de la liaison pour le type d’événement spécifié.

removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Jeu de conditions préalables : BindingEvents

Exemples

function removeEventHandlerFromBinding() {
    Office.select("bindings#MyBinding").removeHandlerAsync(
        Office.EventType.BindingDataChanged, {handler:onBindingDataChanged});
}

Écrit des données dans la section liée du document représenté par l’objet de liaison spécifié.

setDataAsync(data: TableData | any, options?: SetBindingDataOptions, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Ensembles de conditions requises :

• HtmlCoercion (lors de l’utilisation de Office.CoercionType.Html)

• MatrixBindings

• MatrixCoercion (lors de l’utilisation de Office.CoercionType.Matrix)

• OoxmlCoercion (lors de l’utilisation de Office.CoercionType.Ooxml)

• TableBindings

• TableCoercion (lors de l’utilisation de Office.CoercionType.Table)

• TextBindings

• TextCoercion (lors de l’utilisation de Office.CoercionType.Text)

La valeur transmise pour les données contient les données à écrire dans la liaison. Le type de valeur transmis détermine ce qui sera écrit, comme le décrit le tableau suivant.

En outre, ces actions (spécifiques aux applications) s’appliquent lors de l’écriture de données dans une liaison. Pour Word, les données spécifiées sont écrites dans la liaison comme suit.

Pour Excel, les données spécifiées sont écrites dans la liaison comme suit.

Pour Excel sur le Web :

• Le nombre total de cellules dans la valeur transmise au paramètre data ne peut pas dépasser 20 000 lors d’un appel unique à cette méthode.

• Le nombre de groupes de mise en forme transmis au paramètre cellFormat ne peut pas dépasser 100. Un groupe de mise en forme se compose d’un ensemble de mises en forme appliquées à une plage de cellules donnée.

Dans tous les autres cas, une erreur est retournée.

La méthode setDataAsync écrit les données dans un sous-ensemble d’une liaison de table ou de matrice si les paramètres facultatifs startRow et startColumn sont spécifiés et qu’ils spécifient une plage valide.

Dans la fonction de rappel passée à la méthode setDataAsync, vous pouvez utiliser les propriétés de l’objet AsyncResult pour renvoyer les informations suivantes.

Écrit des données dans la section liée du document représenté par l’objet de liaison spécifié.

setDataAsync(data: TableData | any, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Ensembles de conditions requises :

• HtmlCoercion (lors de l’utilisation de Office.CoercionType.Html)

• MatrixBindings

• MatrixCoercion (lors de l’utilisation de Office.CoercionType.Matrix)

• OoxmlCoercion (lors de l’utilisation de Office.CoercionType.Ooxml)

• TableBindings

• TableCoercion (lors de l’utilisation de Office.CoercionType.Table)

• TextBindings

• TextCoercion (lors de l’utilisation de Office.CoercionType.Text)

La valeur transmise pour les données contient les données à écrire dans la liaison. Le type de valeur transmis détermine ce qui sera écrit, comme le décrit le tableau suivant.

En outre, ces actions (spécifiques aux applications) s’appliquent lors de l’écriture de données dans une liaison. Pour Word, les données spécifiées sont écrites dans la liaison comme suit.

Pour Excel, les données spécifiées sont écrites dans la liaison comme suit.

Pour Excel sur le Web :

• Le nombre total de cellules dans la valeur transmise au paramètre data ne peut pas dépasser 20 000 lors d’un appel unique à cette méthode.

• Le nombre de groupes de mise en forme transmis au paramètre cellFormat ne peut pas dépasser 100. Un groupe de mise en forme se compose d’un ensemble de mises en forme appliquées à une plage de cellules donnée.

Dans tous les autres cas, une erreur est retournée.

La méthode setDataAsync écrit les données dans un sous-ensemble d’une liaison de table ou de matrice si les paramètres facultatifs startRow et startColumn sont spécifiés et qu’ils spécifient une plage valide.

Dans la fonction de rappel passée à la méthode setDataAsync, vous pouvez utiliser les propriétés de l’objet AsyncResult pour renvoyer les informations suivantes.

Exemples

function setBindingData() {
    Office.select("bindings#MyBinding").setDataAsync('Hello World!', function (asyncResult) { });
}

// Specifying the optional coercionType parameter lets you specify the kind of data you want to write to a binding.
// For example, in Word if you want to write HTML to a text binding, you can specify the coercionType parameter 
// as "html" as shown in the following example, which uses HTML <b> tags to make "Hello" bold.
function writeHtmlData() {
    Office.select("bindings#myBinding").setDataAsync(
        "<b>Hello</b> World!", {coercionType: "html"}, function (asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            write('Error: ' + asyncResult.error.message);
        }
    });
}

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

// In this example, the call to setDataAsync passes the data parameter as an array of arrays
// (to create a single column of three rows), and specifies the data structure with the 
// coercionType parameter as a "matrix".
function writeBoundDataMatrix() {
    Office.select("bindings#myBinding").setDataAsync(
        [['Berlin'],['Munich'],['Duisburg']],{ coercionType: "matrix" }, function (asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            write('Error: ' + asyncResult.error.message);
        } else {
            write('Bound data: ' + asyncResult.value);
        }
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

// In the writeBoundDataTable function in this example, the call to setDataAsync passes the data parameter 
// as a TableData object (to write three columns and three rows), and specifies the data structure
// with the coercionType parameter as a "table".

// In the updateTableData function, the call to setDataAsync again passes the data parameter as a TableData object,
// but as a single column with a new header and three rows, to update the values in the last column 
// of the table created with the writeBoundDataTable function. The optional zero-based startColumn parameter 
// is specified as 2 to replace the values in the third column of the table.
function writeBoundDataTable() {
    // Create a TableData object.
    const myTable = new Office.TableData();
    myTable.headers = ['First Name', 'Last Name', 'Grade'];
    myTable.rows = [['Kim', 'Abercrombie', 'A'], ['Junmin','Hao', 'C'],['Toni','Poe','B']];

    // Set myTable in the binding.
    Office.select("bindings#myBinding").setDataAsync(myTable, { coercionType: "table" }, 
        function (asyncResult) {
            if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                write('Error: '+ asyncResult.error.message);
        } else {
            write('Bound data: ' + asyncResult.value);
        }
    });
}

// Replace last column with different data.
function updateTableData() {
    const newTable = new Office.TableData();
    newTable.headers = ["Gender"];
    newTable.rows = [["M"],["M"],["F"]];
    Office.select("bindings#myBinding").setDataAsync(newTable, { coercionType: "table", startColumn:2 }, 
        function (asyncResult) {
            if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                write('Error: '+ asyncResult.error.message);
        } else {
            write('Bound data: ' + asyncResult.value);
        }
    });
}

// In this example, the following call passes two formatting groups to cellFormat.
Office.select("bindings#myBinding").setDataAsync([['Berlin'],['Munich'],['Duisburg']],
  {cellFormat:[{cells: {row: 1}, format: {fontColor: "yellow"}}, 
      {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}]}, 
  function (asyncResult){});