Excel.Binding class

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus 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

[ Ensemble d’API : ExcelApi 1.1 ]

Renvoie le type de la liaison. Pour plus d’informations, consultez Excel.BindingType .

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Supprime la liaison.

delete(): void;

Retours

Remarques

[ Ensemble 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 correct.

getRange(): Excel.Range;

Retours

Remarques

[ Ensemble 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 correct.

getTable(): Excel.Table;

Retours

Remarques

[ Ensemble 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 correct.

getText(): OfficeExtension.ClientResult<string>;

Retours

Remarques

[ Ensemble 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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.Binding d’origine est un objet API, la toJSON méthode retourne un objet JavaScript brut (tapé en tant Excel.Interfaces.BindingDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées 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

[ Ensemble 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 discontiguées sont sélectionnées, Binding.onSelectionChanged seules les informations de ligne et de colonne sont fournies pour une seule sélection. Utilisez Worksheet.onSelectionChanged pour plusieurs plages sélectionnées.

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

Type d'événement

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]