Excel.LinkedWorkbookCollection class
Representa uma coleção de objetos de pasta de trabalho vinculados.
- Extends
Comentários
[ Conjunto de API: ExcelApiOnline 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. |
| items | Obtém os itens filhos carregados nesta coleção. |
| workbook |
Representa o modo de atualização dos links da pasta de trabalho. O modo é o mesmo para todos os links de pasta de trabalho presentes na pasta de trabalho. |
Métodos
| break |
Quebra todos os links para as pastas de trabalho vinculadas. Depois que os links são quebrados, todas as fórmulas que referenciam links de pasta de trabalho são totalmente removidas e substituídas pelos valores recuperados mais recentemente. |
| get |
Obtém informações sobre uma pasta de trabalho vinculada por sua URL. |
| get |
Obtém informações sobre uma pasta de trabalho vinculada por sua URL. Se a pasta de trabalho 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 |
| refresh |
Faz uma solicitação para atualizar todos os links da pasta de trabalho. |
| 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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.LinkedWorkbook[];Valor da propriedade
workbookLinksRefreshMode
Representa o modo de atualização dos links da pasta de trabalho. O modo é o mesmo para todos os links de pasta de trabalho presentes na pasta de trabalho.
workbookLinksRefreshMode: Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic";Valor da propriedade
Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic"
Comentários
Detalhes do método
breakAllLinks()
Quebra todos os links para as pastas de trabalho vinculadas. Depois que os links são quebrados, todas as fórmulas que referenciam links de pasta de trabalho são totalmente removidas e substituídas pelos valores recuperados mais recentemente.
breakAllLinks(): void;Retornos
void
Comentários
getItem(key)
Obtém informações sobre uma pasta de trabalho vinculada por sua URL.
getItem(key: string): Excel.LinkedWorkbook;Parâmetros
- key
-
string
A URL da pasta de trabalho vinculada.
Retornos
A pasta de trabalho vinculada com a URL fornecida.
Comentários
getItemOrNullObject(key)
Obtém informações sobre uma pasta de trabalho vinculada por sua URL. Se a pasta de trabalho 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(key: string): Excel.LinkedWorkbook;Parâmetros
- key
-
string
A URL da pasta de trabalho vinculada.
Retornos
A pasta de trabalho vinculada com a URL fornecida.
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 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.LinkedWorkbookCollection;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
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 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
refreshAll()
Faz uma solicitação para atualizar todos os links da pasta de trabalho.
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 é 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.LinkedWorkbookCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado 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;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