Excel.BindingCollection class

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Devuelve el número de enlaces incluidos en la colección.

readonly count: number;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.Binding[];

Valor de propiedad

Agregar un enlace nuevo a un intervalo determinado.

add(range: Range | string, bindingType: Excel.BindingType, id: string): Excel.Binding;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

Agregar un enlace nuevo a un intervalo determinado.

add(range: Range | string, bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

Agregar un enlace nuevo basándose en un elemento con nombre del libro. Si el elemento con nombre hace referencia a varias áreas, se devolverá el InvalidReference error.

addFromNamedItem(name: string, bindingType: Excel.BindingType, id: string): Excel.Binding;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

Agregar un enlace nuevo basándose en un elemento con nombre del libro. Si el elemento con nombre hace referencia a varias áreas, se devolverá el InvalidReference error.

addFromNamedItem(name: string, bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

Agregar un enlace nuevo basándose en la selección actual. Si la selección tiene varias áreas, se devolverá el InvalidReference error.

addFromSelection(bindingType: Excel.BindingType, id: string): Excel.Binding;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

Agregar un enlace nuevo basándose en la selección actual. Si la selección tiene varias áreas, se devolverá el InvalidReference error.

addFromSelection(bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

Obtiene el número de enlaces de la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Obtiene un objeto de enlace por identificador.

getItem(id: string): Excel.Binding;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

async function onBindingDataChanged(eventArgs) {
    await Excel.run(async (context) => { 
        // Highlight the table related to the binding in orange to indicate data has been changed.
        context.workbook.bindings.getItem(eventArgs.binding.id).getTable().getDataBodyRange().format.fill.color = "Orange";
        await context.sync();
        
        console.log("The value in this table got changed!");
    });
}

Obtiene un objeto de enlace según su posición en la matriz de elementos.

getItemAt(index: number): Excel.Binding;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

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

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

Obtiene un objeto de enlace por identificador. Si el objeto de enlace no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getItemOrNullObject(id: string): Excel.Binding;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Ejemplos

await Excel.run(async (context) => { 
    const bindings = context.workbook.bindings;
    bindings.load('items');
    await context.sync();

    for (let i = 0; i < bindings.items.length; i++) {
        console.log(bindings.items[i].id);
    }
});

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.BindingCollection;

Parámetros

Devoluciones

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.BindingCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.BindingCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): Excel.Interfaces.BindingCollectionData;

Devoluciones