Excel.BindingCollection class
Representa a coleção de todos os objetos Binding que fazem parte da pasta de trabalho.
- Extends
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. |
| 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, binding |
Adiciona uma nova associação a um intervalo específico. |
| add(range, binding |
Adiciona uma nova associação a um intervalo específico. |
| add |
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, o |
| add |
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, o |
| add |
Adiciona uma nova associação com base na seleção atual. Se a seleção tiver várias áreas, o |
| add |
Adiciona uma nova associação com base na seleção atual. Se a seleção tiver várias áreas, o |
| get |
Obtém o número de associações da coleção. |
| get |
Obtém um objeto de associação pela ID. |
| get |
Obtém um objeto de associação com base em sua posição na matriz dos itens. |
| get |
Obtém um objeto de associação pela ID. Se o objeto de associação não existir, esse método retornará um objeto com sua |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
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
count
Retorna o número de associações da coleção.
readonly count: number;Valor da propriedade
number
Comentários
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.Binding[];Valor da propriedade
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 de caracteres. 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 da associação.
Retornos
Comentários
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 de caracteres. 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 da associação.
Retornos
Comentários
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, o InvalidReference erro será retornado.
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 da associação.
Retornos
Comentários
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, o InvalidReference erro será retornado.
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 da associação.
Retornos
Comentários
addFromSelection(bindingType, id)
Adiciona uma nova associação com base na seleção atual. Se a seleção tiver várias áreas, o InvalidReference erro será retornado.
addFromSelection(bindingType: Excel.BindingType, id: string): Excel.Binding;Parâmetros
- bindingType
- Excel.BindingType
Tipo de associação. Consulte Excel.BindingType.
- id
-
string
Nome da associação.
Retornos
Comentários
addFromSelection(bindingTypeString, id)
Adiciona uma nova associação com base na seleção atual. Se a seleção tiver várias áreas, o InvalidReference erro será retornado.
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 da associação.
Retornos
Comentários
getCount()
Obtém o número de associações da coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
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
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
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 associação não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getItemOrNullObject(id: string): Excel.Binding;Parâmetros
- id
-
string
ID do objeto Binding a recuperar.
Retornos
Comentários
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
Fornece opções para quais propriedades do objeto carregar.
Retornos
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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
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);
}
});
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 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
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.) Considerando que o objeto original Excel.BindingCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado 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
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de