PowerPoint.Binding class
Represents an Office.js binding that is defined in the presentation.
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| id | Represents the binding identifier. |
| type | Returns the type of the binding. See |
Methods
| delete() | Deletes the binding. |
| get |
Returns the shape represented by the binding. Will throw an error if the binding isn't of the correct type. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
id
Represents the binding identifier.
readonly id: string;Property Value
string
Remarks
type
Returns the type of the binding. See BindingType for details.
readonly type: PowerPoint.BindingType | "Shape";Property Value
PowerPoint.BindingType | "Shape"
Remarks
Method Details
delete()
getShape()
Returns the shape represented by the binding. Will throw an error if the binding isn't of the correct type.
getShape(): PowerPoint.Shape;Returns
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: PowerPoint.Interfaces.BindingLoadOptions): PowerPoint.Binding;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): PowerPoint.Binding;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.Binding;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original PowerPoint.Binding object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.BindingData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): PowerPoint.Interfaces.BindingData;