Excel.BindingCollection class

Referência

Pacote:: excel

Representa a coleção de todos os objetos Binding que fazem parte da pasta de trabalho.

Extends: OfficeExtension.ClientObject

Comentários

Propriedades

context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
count	Retorna o número de associações da coleção.
items	Obtém os itens filhos carregados nesta coleção.

Métodos

add(range, bindingType, id)	Adiciona uma nova associação a um intervalo específico.
add(range, bindingTypeString, id)	Adiciona uma nova associação a um intervalo específico.
addFromNamedItem(name, bindingType, id)	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, bindingTypeString, id)	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.
addFromSelection(bindingType, id)	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, id)	Adiciona uma nova associação com base na seleção atual. Se a seleção tiver várias áreas, será devolvido o `InvalidReference` erro.
getCount()	Obtém o número de associações da coleção.
getItem(id)	Obtém um objeto de associação pela ID.
getItemAt(index)	Obtém um objeto de associação com base em sua posição na matriz dos itens.
getItemOrNullObject(id)	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).
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 é transmitido para `JSON.stringify()`. (`JSON.stringify`por 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.

Detalhes da propriedade

context

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

Excel.RequestContext

count

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

readonly count: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

items

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

readonly items: Excel.Binding[];

Valor da propriedade

Excel.Binding[]

Detalhes do método

add(range, bindingType, id)

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

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

Parâmetros

range: Excel.Range | string

Intervalo para vincular a associação. Pode ser um Range objeto ou uma cadeia. Se for uma cadeia de caracteres, deve conter o endereço completo, incluindo o nome da planilha

bindingType: Excel.BindingType

Tipo de associação. Consulte Excel.BindingType.

id: string

Nome do enlace.

Retornos

Excel.Binding

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

add(range, bindingTypeString, id)

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

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

Parâmetros

range: Excel.Range | string

Intervalo para vincular a associação. Pode ser um Range objeto ou uma cadeia. Se for uma cadeia de caracteres, deve conter o endereço completo, incluindo o nome da planilha

bindingTypeString: "Range" | "Table" | "Text"

Tipo de associação. Consulte Excel.BindingType.

id: string

Nome do enlace.

Retornos

Excel.Binding

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

addFromNamedItem(name, bindingType, id)

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

name: string

Nome do qual deseja criar a associação.

bindingType: Excel.BindingType

Tipo de associação. Consulte Excel.BindingType.

id: string

Nome do enlace.

Retornos

Excel.Binding

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

addFromNamedItem(name, bindingTypeString, id)

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

name: string

Nome do qual deseja criar a associação.

bindingTypeString: "Range" | "Table" | "Text"

Tipo de associação. Consulte Excel.BindingType.

id: string

Nome do enlace.

Retornos

Excel.Binding

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

addFromSelection(bindingType, id)

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

bindingType: Excel.BindingType

Tipo de associação. Consulte Excel.BindingType.

id: string

Nome do enlace.

Retornos

Excel.Binding

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

addFromSelection(bindingTypeString, id)

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

bindingTypeString: "Range" | "Table" | "Text"

Tipo de associação. Consulte Excel.BindingType.

id: string

Nome do enlace.

Retornos

Excel.Binding

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

getItem(id)

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

getItem(id: string): Excel.Binding;

Parâmetros

id: string

ID do objeto Binding a recuperar.

Retornos

Excel.Binding

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

getItemAt(index)

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

getItemAt(index: number): Excel.Binding;

Parâmetros

index: number

Valor de índice do objeto a ser recuperado. Indexados com zero.

Retornos

Excel.Binding

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

getItemOrNullObject(id)

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

id: string

ID do objeto Binding a recuperar.

Retornos

Excel.Binding

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

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

Parâmetros

options: Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.BindingCollection

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

Parâmetros

propertyNames: string | string[]

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

Retornos

Excel.BindingCollection

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

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?: OfficeExtension.LoadOption): Excel.BindingCollection;

Parâmetros

propertyNamesAndPaths: OfficeExtension.LoadOption

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

Retornos

Excel.BindingCollection

toJSON()

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

Excel.Interfaces.BindingCollectionData

Compartilhar via

Excel.BindingCollection class

Comentários

Propriedades

Métodos

Detalhes da propriedade

context

Valor da propriedade

count

Valor da propriedade

Comentários

items

Valor da propriedade

Detalhes do método

add(range, bindingType, id)

Parâmetros

Retornos

Comentários

add(range, bindingTypeString, id)

Parâmetros

Retornos

Comentários

addFromNamedItem(name, bindingType, id)

Parâmetros

Retornos

Comentários

addFromNamedItem(name, bindingTypeString, id)

Parâmetros

Retornos

Comentários

addFromSelection(bindingType, id)

Parâmetros

Retornos

Comentários

addFromSelection(bindingTypeString, id)

Parâmetros

Retornos

Comentários

getCount()

Retornos

Comentários

getItem(id)

Parâmetros

Retornos

Comentários

Exemplos

getItemAt(index)

Parâmetros

Retornos

Comentários

Exemplos

getItemOrNullObject(id)

Parâmetros

Retornos

Comentários

load(options)

Parâmetros

Retornos

load(propertyNames)

Parâmetros

Retornos

Exemplos

load(propertyNamesAndPaths)

Parâmetros

Retornos

toJSON()

Retornos

Recursos adicionais