PowerPoint.Binding class
表示在演示文稿中定义的 Office.js 绑定。
注解
示例
// 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;
});
}
属性
context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
id | 表示绑定标识符。 |
type | 返回绑定的类型。 有关详细信息,请参阅 |
方法
delete() | 删除 binding 对象。 |
get |
返回由绑定表示的形状。 如果绑定的类型不正确,将引发错误。 |
load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
toJSON() | 重写 JavaScript |
属性详细信息
context
id
type
返回绑定的类型。 有关详细信息,请参阅 BindingType
。
readonly type: PowerPoint.BindingType | "Shape";
属性值
PowerPoint.BindingType | "Shape"
注解
方法详细信息
delete()
getShape()
返回由绑定表示的形状。 如果绑定的类型不正确,将引发错误。
getShape(): PowerPoint.Shape;
返回
注解
示例
// 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)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(options?: PowerPoint.Interfaces.BindingLoadOptions): PowerPoint.Binding;
参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(propertyNames?: string | string[]): PowerPoint.Binding;
参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.Binding;
参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand
一个逗号分隔的字符串,指定要加载的导航属性。
返回
toJSON()
重写 JavaScript toJSON()
方法,以便在将 API 对象传递给 JSON.stringify()
时提供更有用的输出。
JSON.stringify
(,依次调用toJSON
传递给它的 对象的 方法。) 虽然原始PowerPoint.Binding
对象是 API 对象,toJSON
但该方法返回一个纯 JavaScript 对象, (类型为 PowerPoint.Interfaces.BindingData
) ,其中包含从原始对象加载的任何子属性的浅表副本。
toJSON(): PowerPoint.Interfaces.BindingData;