Compartir a través de


Excel.BindingCollection class

Representa la colección de todos los objetos de enlace que forman parte del libro.

Extends

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Propiedades

context

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

count

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

items

Obtiene los elementos secundarios cargados en esta colección.

Métodos

add(range, bindingType, id)

Agregar un enlace nuevo a un intervalo determinado.

add(range, bindingTypeString, id)

Agregar un enlace nuevo a un intervalo determinado.

addFromNamedItem(name, bindingType, id)

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, bindingTypeString, id)

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.

addFromSelection(bindingType, id)

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, id)

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

getCount()

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

getItem(id)

Obtiene un objeto de enlace por identificador.

getItemAt(index)

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

getItemOrNullObject(id)

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).

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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.

Detalles de las propiedades

context

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

count

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

readonly count: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.Binding[];

Valor de propiedad

Detalles del método

add(range, bindingType, id)

Agregar un enlace nuevo a un intervalo determinado.

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

Parámetros

range

Excel.Range | string

Intervalo al que se va a vincular el enlace. Puede ser un Range objeto o una cadena. Si es una cadena, debe incluir la dirección completa, incluido el nombre de la hoja

bindingType
Excel.BindingType

Tipo de enlace. Consulte Excel.BindingType.

id

string

Nombre del enlace.

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

add(range, bindingTypeString, id)

Agregar un enlace nuevo a un intervalo determinado.

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

Parámetros

range

Excel.Range | string

Intervalo al que se va a vincular el enlace. Puede ser un Range objeto o una cadena. Si es una cadena, debe incluir la dirección completa, incluido el nombre de la hoja

bindingTypeString

"Range" | "Table" | "Text"

Tipo de enlace. Consulte Excel.BindingType.

id

string

Nombre del enlace.

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

addFromNamedItem(name, bindingType, id)

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

name

string

Nombre desde el que se va a crear el enlace.

bindingType
Excel.BindingType

Tipo de enlace. Consulte Excel.BindingType.

id

string

Nombre del enlace.

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

addFromNamedItem(name, bindingTypeString, id)

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

name

string

Nombre desde el que se va a crear el enlace.

bindingTypeString

"Range" | "Table" | "Text"

Tipo de enlace. Consulte Excel.BindingType.

id

string

Nombre del enlace.

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

addFromSelection(bindingType, id)

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

bindingType
Excel.BindingType

Tipo de enlace. Consulte Excel.BindingType.

id

string

Nombre del enlace.

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

addFromSelection(bindingTypeString, id)

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

bindingTypeString

"Range" | "Table" | "Text"

Tipo de enlace. Consulte Excel.BindingType.

id

string

Nombre del enlace.

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

getItem(id)

Obtiene un objeto de enlace por identificador.

getItem(id: string): Excel.Binding;

Parámetros

id

string

Identificador del objeto de contenido que se va a recuperar.

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

getItemAt(index)

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

getItemAt(index: number): Excel.Binding;

Parámetros

index

number

Valor de índice del objeto que se va a recuperar. Indizado con cero.

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

getItemOrNullObject(id)

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

id

string

Identificador del objeto de contenido que se va a recuperar.

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

load(options)

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

options

Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

load(propertyNames)

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

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

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

load(propertyNamesAndPaths)

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

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

toJSON()

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