Excel.Binding class

Paquete:

excel

Representa un enlace de Office.js que se define en el libro.

Extends

OfficeExtension.ClientObject

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.
id	Representa el identificador de enlace.
type	Devuelve el tipo de enlace. Vea Excel.BindingType para más información.

Métodos

delete()	Elimina el enlace.
getRange()	Devuelve el intervalo representado por el enlace. Producirá un error si el enlace no es del tipo correcto.
getTable()	Devuelve la tabla representada por el enlace. Producirá un error si el enlace no es del tipo correcto.
getText()	Devuelve el texto representado por el enlace. Producirá un error si el enlace no es del tipo correcto.
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 Excel.Binding original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.BindingData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Eventos

onDataChanged	Se produce al cambiar los datos del enlace o al darles formato.
onSelectionChanged	Se produce cuando se cambia el contenido seleccionado en el enlace. Nota*: Si se seleccionan varias celdas no coincidentes, Binding.onSelectionChanged solo informa de la información de fila y columna de una selección. Use Worksheet.onSelectionChanged para varios intervalos seleccionados.

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

Excel.RequestContext

id

Representa el identificador de enlace.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

type

Devuelve el tipo de enlace. Vea Excel.BindingType para más información.

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

Valor de propiedad

Excel.BindingType | "Range" | "Table" | "Text"

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Detalles del método

delete()

Elimina el enlace.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

getRange()

Devuelve el intervalo representado por el enlace. Producirá un error si el enlace no es del tipo correcto.

getRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

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

Devuelve la tabla representada por el enlace. Producirá un error si el enlace no es del tipo correcto.

getTable(): Excel.Table;

Devoluciones

Excel.Table

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

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

Devuelve el texto representado por el enlace. Producirá un error si el enlace no es del tipo correcto.

getText(): OfficeExtension.ClientResult<string>;

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

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

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.BindingLoadOptions): Excel.Binding;

Parámetros

options

Excel.Interfaces.BindingLoadOptions

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

Devoluciones

Excel.Binding

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.Binding;

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

Excel.Binding

Ejemplos

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

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

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?: {
            select?: string;
            expand?: string;
        }): Excel.Binding;

Parámetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

Excel.Binding

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 Excel.Binding original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.BindingData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.BindingData;

Devoluciones

Excel.Interfaces.BindingData

Detalles del evento

onDataChanged

Se produce al cambiar los datos del enlace o al darles formato.

readonly onDataChanged: OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/data-changed.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");    
    const salesTable = sheet.tables.getItem("SalesTable");
    const salesByQuarterBinding = context.workbook.bindings.add(salesTable.getRange(), "Table", "SalesByQuarter");
    salesByQuarterBinding.onDataChanged.add(onSalesDataChanged);

    console.log("The data changed handler is registered.");

    await context.sync();
});

onSelectionChanged

Se produce cuando se cambia el contenido seleccionado en el enlace.

Nota*: Si se seleccionan varias celdas no coincidentes, Binding.onSelectionChanged solo informa de la información de fila y columna de una selección. Use Worksheet.onSelectionChanged para varios intervalos seleccionados.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]