Excel.Binding class

  • Referência
Pacote:
excel

Representa uma associação do Office.js definida na pasta de trabalho.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
id

Representa o identificador de associação.
type

Retorna o tipo da associação. Confira Excel.BindingType detalhes.

Métodos

delete()

Especifica a associação.
getRange()

Retorna o intervalo representado pela associação. Gerará um erro se a associação não for do tipo correto.
getTable()

Retorna a tabela representada pela associação. Gerará um erro se a associação não for do tipo correto.
getText()

Retorna o texto representado pela associação. Gerará um erro se a associação não for do tipo correto.
load(options)

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

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

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

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

Eventos

onDataChanged

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

Ocorre quando o conteúdo selecionado na associação é alterado.

Observação*: se várias células descoloridas forem selecionadas, Binding.onSelectionChanged apenas relatará informações de linha e coluna para uma seleção. Use Worksheet.onSelectionChanged para vários intervalos selecionados.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

id

Representa o identificador de associação.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

type

Retorna o tipo da associação. Confira Excel.BindingType detalhes.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Detalhes do método

delete()

Especifica a associação.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

getRange()

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

getRange(): Excel.Range;

Retornos

Excel.Range

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

getTable()

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

getTable(): Excel.Table;

Retornos

Excel.Table

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

getText()

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

getText(): OfficeExtension.ClientResult<string>;

Retornos

OfficeExtension.ClientResult<string>

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

load(options)

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

options
Excel.Interfaces.BindingLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.Binding

load(propertyNames)

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

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.Binding

Exemplos

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

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

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.Binding

toJSON()

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

toJSON(): Excel.Interfaces.BindingData;

Retornos

Excel.Interfaces.BindingData

Detalhes do evento

onDataChanged

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>

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

onSelectionChanged

Ocorre quando o conteúdo selecionado na associação é alterado.

Observação*: se várias células descoloridas forem selecionadas, Binding.onSelectionChanged apenas relatará informações de linha e coluna para uma seleção. Use Worksheet.onSelectionChanged para vários intervalos selecionados.

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.2 ]