Excel.LinkedWorkbook class
Contém informações sobre um livro ligado. Se um livro tiver ligações que apontam para dados noutro livro, o segundo livro está ligado ao primeiro livro. Neste cenário, o segundo livro é denominado "livro ligado".
- Extends
Comentários
[ Conjunto de API: ExcelApiOnline 1.1 ]
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. |
| id | O URL original que aponta para o livro ligado. É exclusivo em todos os livros ligados na coleção. |
Métodos
| break |
Faz um pedido para interromper as ligações que apontam para o livro ligado. As ligações nas fórmulas são substituídas pelos dados obtidos mais recentemente. O objeto atual |
| 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 |
| refresh() | Faz um pedido para atualizar os dados obtidos a partir do livro ligado. |
| toJSON() | Substitui o método JavaScript |
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
id
O URL original que aponta para o livro ligado. É exclusivo em todos os livros ligados na coleção.
readonly id: string;Valor da propriedade
string
Comentários
Detalhes do método
breakLinks()
Faz um pedido para interromper as ligações que apontam para o livro ligado. As ligações nas fórmulas são substituídas pelos dados obtidos mais recentemente. O objeto atual LinkedWorkbook é invalidado e removido de LinkedWorkbookCollection.
breakLinks(): void;Retornos
void
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.LinkedWorkbookLoadOptions): Excel.LinkedWorkbook;Parâmetros
Fornece opções para as propriedades do objeto a 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.LinkedWorkbook;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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.LinkedWorkbook;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
refresh()
Faz um pedido para atualizar os dados obtidos a partir do livro ligado.
refresh(): void;Retornos
void
Comentários
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.LinkedWorkbook é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.LinkedWorkbookData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.LinkedWorkbookData;