Excel.Binding class

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

表示绑定标识符。

readonly id: string;

属性值

注解

[ API 集：ExcelApi 1.1 ]

返回绑定的类型。 有关详细信息，请参阅 Excel.BindingType。

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

属性值

注解

[ API 集：ExcelApi 1.1 ]

返回绑定表示的区域。 如果绑定的类型不正确，将引发错误。

getRange(): Excel.Range;

返回

注解

[ API 集：ExcelApi 1.1 ]

示例

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(): Excel.Table;

返回

注解

[ API 集：ExcelApi 1.1 ]

示例

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(): OfficeExtension.ClientResult<string>;

返回

注解

[ API 集：ExcelApi 1.1 ]

示例

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

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.BindingLoadOptions): Excel.Binding;

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.Binding;

参数

返回

示例

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

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

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Binding;

参数

返回

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.Binding对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.BindingData) ，其中包含原始对象中任何已加载子属性的浅表副本。

toJSON(): Excel.Interfaces.BindingData;

返回