Excel.LinkedWorkbookCollection class
Representa uma coleção de objetos de livros ligados.
- 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. |
| items | Obtém os itens filhos carregados nesta coleção. |
| workbook |
Representa o modo de atualização das ligações do livro. O modo é o mesmo para todas as ligações do livro presentes no livro. |
Métodos
| break |
Quebra todas as ligações para os livros ligados. Depois de as ligações serem quebradas, todas as fórmulas que referenciam ligações de livros são removidas por completo e substituídas pelos valores obtidos mais recentemente. |
| get |
Obtém informações sobre um livro ligado através do respetivo URL. |
| get |
Obtém informações sobre um livro ligado através do respetivo URL. Se o livro não existir, este método devolve um objeto com a respetiva |
| 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 todas as ligações do livro. |
| 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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.LinkedWorkbook[];Valor da propriedade
workbookLinksRefreshMode
Representa o modo de atualização das ligações do livro. O modo é o mesmo para todas as ligações do livro presentes no livro.
workbookLinksRefreshMode: Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic";Valor da propriedade
Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic"
Comentários
Detalhes do método
breakAllLinks()
Quebra todas as ligações para os livros ligados. Depois de as ligações serem quebradas, todas as fórmulas que referenciam ligações de livros são removidas por completo e substituídas pelos valores obtidos mais recentemente.
breakAllLinks(): void;Retornos
void
Comentários
getItem(key)
Obtém informações sobre um livro ligado através do respetivo URL.
getItem(key: string): Excel.LinkedWorkbook;Parâmetros
- key
-
string
O URL do livro ligado.
Retornos
O livro ligado com o URL especificado.
Comentários
getItemOrNullObject(key)
Obtém informações sobre um livro ligado através do respetivo URL. Se o livro 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(key: string): Excel.LinkedWorkbook;Parâmetros
- key
-
string
O URL do livro ligado.
Retornos
O livro ligado com um determinado URL.
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.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedWorkbookCollection;Parâmetros
- options
-
Excel.Interfaces.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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.LinkedWorkbookCollection;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?: OfficeExtension.LoadOption): Excel.LinkedWorkbookCollection;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
refreshAll()
Faz um pedido para atualizar todas as ligações do livro.
refreshAll(): 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.LinkedWorkbookCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.LinkedWorkbookCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.LinkedWorkbookCollectionData;