Excel.LinkedWorkbook class

  • Referencia
Paquete:
excel

Contiene información sobre un libro vinculado. Si un libro tiene vínculos que apuntan a datos de otro libro, el segundo libro está vinculado al primer libro. En este escenario, el segundo libro se denomina "libro vinculado".

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

Propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
id

Dirección URL original que apunta al libro vinculado. Es único en todos los libros vinculados de la colección.

Métodos

breakLinks()

Realiza una solicitud para interrumpir los vínculos que apuntan al libro vinculado. Los vínculos de las fórmulas se reemplazan por los datos capturados más recientes. El objeto actual LinkedWorkbook se invalida y se quita de LinkedWorkbookCollection.
load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
refresh()

Realiza una solicitud para actualizar los datos recuperados del libro vinculado.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.LinkedWorkbook es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.LinkedWorkbookData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

id

Dirección URL original que apunta al libro vinculado. Es único en todos los libros vinculados de la colección.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

Detalles del método

Realiza una solicitud para interrumpir los vínculos que apuntan al libro vinculado. Los vínculos de las fórmulas se reemplazan por los datos capturados más recientes. El objeto actual LinkedWorkbook se invalida y se quita de LinkedWorkbookCollection.

breakLinks(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.LinkedWorkbookLoadOptions): Excel.LinkedWorkbook;

Parámetros

options
Excel.Interfaces.LinkedWorkbookLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.LinkedWorkbook

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.LinkedWorkbook;

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.LinkedWorkbook

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.LinkedWorkbook;

Parámetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.LinkedWorkbook

refresh()

Realiza una solicitud para actualizar los datos recuperados del libro vinculado.

refresh(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.LinkedWorkbook es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.LinkedWorkbookData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.LinkedWorkbookData;

Devoluciones

Excel.Interfaces.LinkedWorkbookData