Excel.Binding class

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Representa o identificador de enlace.

readonly id: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Retorna o tipo da associação. Veja Excel.BindingType para obter detalhes.

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Especifica a associação.

delete(): void;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

Retorna o intervalo representado pela associação. Emitirá um erro se o enlace não for do tipo correto.

getRange(): Excel.Range;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

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

Retorna a tabela representada pela associação. Emitirá um erro se o enlace não for do tipo correto.

getTable(): Excel.Table;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

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

Retorna o texto representado pela associação. Emitirá um erro se o enlace não for do tipo correto.

getText(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

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

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Exemplos

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

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

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.Binding é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.BindingData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.BindingData;

Retornos

Ocorre quando os dados ou a formatação dentro da associação são alterados.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

Exemplos

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

Ocorre quando o conteúdo selecionado no enlace é alterado.

Nota*: se estiverem selecionadas múltiplas células descontínuas, Binding.onSelectionChanged apenas comunica informações de linhas e colunas para uma seleção. Utilize Worksheet.onSelectionChanged para vários intervalos selecionados.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.2 ]