Excel.Binding class

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Représente l’identificateur de liaison.

readonly id: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Renvoie le type de la liaison. Pour Excel.BindingType plus de détails.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Supprime la liaison.

delete(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.3

Renvoie la plage représentée par la liaison. Génère une erreur si la liaison n’est pas du type approprié.

getRange(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

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

Renvoie le tableau représenté par la liaison. Génère une erreur si la liaison n’est pas du type approprié.

getTable(): Excel.Table;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

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

Renvoie le texte représenté par la liaison. Génère une erreur si la liaison n’est pas du type approprié.

getText(): OfficeExtension.ClientResult<string>;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

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

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.BindingLoadOptions): Excel.Binding;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.Binding;

Paramètres

Retours

Exemples

await Excel.run(async (context) => { 
    const binding = context.workbook.bindings.getItemAt(0);
    binding.load('type');
    await context.sync();

    console.log(binding.type);
});

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Binding;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Binding est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.BindingDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.BindingData;

Retours

Se produit lors de la modification des données ou de la mise en forme dans la liaison.

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.2

Exemples

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

Se produit lorsque le contenu sélectionné dans la liaison est modifié.

Remarque : Si plusieurs cellules non contiguës sont sélectionnées, Binding.onSelectionChanged seules les informations sur les lignes et les colonnes sont associées à une sélection. Utiliser Worksheet.onSelectionChanged pour plusieurs plages sélectionnées.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.2