PowerPoint.Binding class
Représente une liaison Office.js définie dans la présentation.
- Extends
Remarques
Utilisateur
- PowerPoint.BindingCollection : add, addFromSelection, getItem, getItemAt, getItemOrNullObject, items
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/binding-to-shapes.yaml
async function getShapeForBindingId(bindingId: string): Promise<PowerPoint.Shape | undefined> {
// Gets shape associated with binding ID.
return PowerPoint.run(async (context) => {
const binding = context.presentation.bindings.getItem(bindingId);
const shape = binding.getShape();
return shape;
});
}
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 forme représentée 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 |
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
type
Renvoie le type de la liaison. Pour BindingType plus de détails.
readonly type: PowerPoint.BindingType | "Shape";
Valeur de propriété
PowerPoint.BindingType | "Shape"
Remarques
Détails de la méthode
delete()
getShape()
Renvoie la forme représentée par la liaison. Génère une erreur si la liaison n’est pas du type approprié.
getShape(): PowerPoint.Shape;
Retours
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/binding-to-shapes.yaml
async function getShapeForBindingId(bindingId: string): Promise<PowerPoint.Shape | undefined> {
// Gets shape associated with binding ID.
return PowerPoint.run(async (context) => {
const binding = context.presentation.bindings.getItem(bindingId);
const shape = binding.getShape();
return shape;
});
}
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?: PowerPoint.Interfaces.BindingLoadOptions): PowerPoint.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[]): PowerPoint.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;
}): PowerPoint.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 PowerPoint.Binding est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) PowerPoint.Interfaces.BindingDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): PowerPoint.Interfaces.BindingData;