Excel.Binding class
Representa uma associação do Office.js definida na pasta de trabalho.
- Extends
Comentários
[Conjunto de apis: 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. Consulte |
Métodos
| delete() | Especifica a associação. |
| get |
Retorna o intervalo representado pela associação. Lançará um erro se a associação não for do tipo correto. |
| get |
Retorna a tabela representada pela associação. Lançará um erro se a associação não for do tipo correto. |
| get |
Retorna o texto representado pela associação. Lançará 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 |
| 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 |
Eventos
| on |
Ocorre quando os dados ou a formatação dentro da associação são alterados. |
| on |
Ocorre quando o conteúdo selecionado na associação é alterado.
Observação: Se várias células descontíguas forem selecionadas, |
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
id
Representa o identificador de associação.
readonly id: string;Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.1]
type
Retorna o tipo da associação. Consulte Excel.BindingType para obter detalhes.
readonly type: Excel.BindingType | "Range" | "Table" | "Text";Valor da propriedade
Excel.BindingType | "Range" | "Table" | "Text"
Comentários
[Conjunto de apis: ExcelApi 1.1]
Detalhes do método
delete()
Especifica a associação.
delete(): void;Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.3]
getRange()
Retorna o intervalo representado pela associação. Lançará um erro se a associação não for do tipo correto.
getRange(): Excel.Range;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.1]
getTable()
Retorna a tabela representada pela associação. Lançará um erro se a associação não for do tipo correto.
getTable(): Excel.Table;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.1]
getText()
Retorna o texto representado pela associação. Lançará um erro se a associação não for do tipo correto.
getText(): OfficeExtension.ClientResult<string>;Retornos
OfficeExtension.ClientResult<string>
Comentários
[Conjunto de apis: ExcelApi 1.1]
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
Fornece opções para quais propriedades do objeto devem ser carregadas.
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.Binding;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
Retornos
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írgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula 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.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.Binding é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.BindingData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.BindingData;Retornos
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
Comentários
[Conjunto de apis: ExcelApi 1.2]
onSelectionChanged
Ocorre quando o conteúdo selecionado na associação é alterado.
Observação: Se várias células descontíguas forem selecionadas, Binding.onSelectionChanged relatará apenas 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
Comentários
[Conjunto de apis: ExcelApi 1.2]