Partager via

Excel.Binding class

  • Référence
Paquet:
excel

Représente une liaison Office.js définie dans le classeur.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Propriétés

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
id

Représente l’identificateur de liaison.
type

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

Méthodes

getRange()

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

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

Renvoie le texte représenté par la liaison. Génère une erreur si la liaison n’est pas du type correct.
load(options)

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)

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)

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.
toJSON()

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 d’origine Excel.Binding est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.BindingDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Événements

onDataChanged

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

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.

Détails de la propriété

context

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é

Excel.RequestContext

id

Représente l’identificateur de liaison.

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

type

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

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

Valeur de propriété

Excel.BindingType | "Range" | "Table" | "Text"

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Détails de la méthode

getRange()

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

Excel.Range

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

getTable()

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

Excel.Table

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

getText()

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

OfficeExtension.ClientResult<string>

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

load(options)

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

options
Excel.Interfaces.BindingLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.Binding

load(propertyNames)

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

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.Binding

Exemples

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

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

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.Binding

toJSON()

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 d’origine Excel.Binding est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé 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

Excel.Interfaces.BindingData

Détails de l'événement

onDataChanged

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

OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>

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

onSelectionChanged

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

OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]