Excel.LinkedWorkbook class

Pacote:

excel

Contém informações sobre uma pasta de trabalho vinculada. Se uma pasta de trabalho tiver links apontando para dados em outra pasta de trabalho, a segunda pasta de trabalho será vinculada à primeira pasta de trabalho. Nesse cenário, a segunda pasta de trabalho é chamada de "pasta de trabalho vinculada".

Extends

OfficeExtension.ClientObject

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.
id	A URL original apontando para a pasta de trabalho vinculada. Ela é exclusiva em todas as pastas de trabalho vinculadas da coleção.

Métodos

breakLinks()	Faz uma solicitação para quebrar os links que apontam para a pasta de trabalho vinculada. Os links nas fórmulas são substituídos pelos dados buscados mais recentes. O objeto atual LinkedWorkbook é invalidado e removido de LinkedWorkbookCollection.
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(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
refresh()	Faz uma solicitação para atualizar os dados recuperados da pasta de trabalho vinculada.
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.) Enquanto o objeto Excel.LinkedWorkbook original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.LinkedWorkbookData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

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

Excel.RequestContext

id

A URL original apontando para a pasta de trabalho vinculada. Ela é exclusiva em todas as pastas de trabalho vinculadas da coleção.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Detalhes do método

breakLinks()

Faz uma solicitação para quebrar os links que apontam para a pasta de trabalho vinculada. Os links nas fórmulas são substituídos pelos dados buscados mais recentes. O objeto atual LinkedWorkbook é invalidado e removido de LinkedWorkbookCollection.

breakLinks(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 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.LinkedWorkbookLoadOptions): Excel.LinkedWorkbook;

Parâmetros

options

Excel.Interfaces.LinkedWorkbookLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.LinkedWorkbook

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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.LinkedWorkbook

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 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

Excel.LinkedWorkbook

refresh()

Faz uma solicitação para atualizar os dados recuperados da pasta de trabalho vinculada.

refresh(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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.) Enquanto o objeto Excel.LinkedWorkbook original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.LinkedWorkbookData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.LinkedWorkbookData;

Retornos

Excel.Interfaces.LinkedWorkbookData