Excel.BindingCollection 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

Retorna o número de associações da coleção.

readonly count: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.Binding[];

Valor da propriedade

Adiciona uma nova associação a um intervalo específico.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

Adiciona uma nova associação a um intervalo específico.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

Adiciona uma nova associação com base em um item nomeado na pasta de trabalho. Se o item nomeado fizer referência a várias áreas, será devolvido o InvalidReference erro.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

Adiciona uma nova associação com base em um item nomeado na pasta de trabalho. Se o item nomeado fizer referência a várias áreas, será devolvido o InvalidReference erro.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

Adiciona uma nova associação com base na seleção atual. Se a seleção tiver várias áreas, será devolvido o InvalidReference erro.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

Adiciona uma nova associação com base na seleção atual. Se a seleção tiver várias áreas, será devolvido o InvalidReference erro.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

Obtém o número de associações da coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

Obtém um objeto de associação pela ID.

getItem(id: string): Excel.Binding;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

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

Obtém um objeto de associação com base em sua posição na matriz dos itens.

getItemAt(index: number): Excel.Binding;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

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

Obtém um objeto de associação pela ID. Se o objeto de enlace não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getItemOrNullObject(id: string): Excel.Binding;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

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.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection;

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

Parâmetros

Retornos

Exemplos

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

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

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

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.BindingCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.BindingCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.BindingCollectionData;

Retornos