Excel.Binding class
Représente une liaison Office.js définie dans le classeur.
- Extends
Remarques
[Jeu d’API : ExcelApi 1.1]
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| id | Représente l’identificateur de liaison. |
| type | Renvoie le type de la liaison. Pour |
Méthodes
| delete() | Supprime la liaison. |
| get |
Renvoie la plage représentée par la liaison. Génère une erreur si la liaison n’est pas du type approprié. |
| get |
Renvoie le tableau représenté par la liaison. Génère une erreur si la liaison n’est pas du type approprié. |
| get |
Renvoie le texte représenté par la liaison. Génère une erreur si la liaison n’est pas du type approprié. |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| toJSON() | Remplace la méthode JavaScript |
Événements
| on |
Se produit lors de la modification des données ou de la mise en forme dans la liaison. |
| on |
Se produit lorsque le contenu sélectionné dans la liaison est modifié.
Remarque : Si plusieurs cellules non contiguës sont sélectionnées, |
Détails de la propriété
context
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é
id
Représente l’identificateur de liaison.
readonly id: string;Valeur de propriété
string
Remarques
[Jeu d’API : ExcelApi 1.1]
type
Renvoie le type de la liaison. Pour Excel.BindingType plus de détails.
readonly type: Excel.BindingType | "Range" | "Table" | "Text";Valeur de propriété
Excel.BindingType | "Range" | "Table" | "Text"
Remarques
[Jeu d’API : ExcelApi 1.1]
Détails de la méthode
delete()
Supprime la liaison.
delete(): void;Retours
void
Remarques
[Jeu d’API : ExcelApi 1.3]
getRange()
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]
getTable()
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]
getText()
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
OfficeExtension.ClientResult<string>
Remarques
[Jeu d’API : ExcelApi 1.1]
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
Fournit des options pour les propriétés de l’objet à charger.
Retours
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 spécifiant les propriétés à charger.
Retours
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
toJSON()
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
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
Remarques
[Jeu d’API : ExcelApi 1.2]
onSelectionChanged
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]