Excel.LinkedWorkbookCollection class

Representa una colección de objetos de libro vinculados.

Extends

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.

items

Obtiene los elementos secundarios cargados en esta colección.

workbookLinksRefreshMode

Representa el modo de actualización de los vínculos del libro. El modo es el mismo para todos los vínculos de libro presentes en el libro.

Métodos

breakAllLinks()

Interrumpe todos los vínculos a los libros vinculados. Una vez rotos los vínculos, las fórmulas que hacen referencia a los vínculos de libro se quitan por completo y se reemplazan por los valores recuperados más recientemente.

getItem(key)

Obtiene información sobre un libro vinculado por su dirección URL.

getItemOrNullObject(key)

Obtiene información sobre un libro vinculado por su dirección URL. Si el libro no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

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.

refreshAll()

Realiza una solicitud para actualizar todos los vínculos del libro.

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.LinkedWorkbookCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.LinkedWorkbookCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

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

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.LinkedWorkbook[];

Valor de propiedad

workbookLinksRefreshMode

Representa el modo de actualización de los vínculos del libro. El modo es el mismo para todos los vínculos de libro presentes en el libro.

workbookLinksRefreshMode: Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic";

Valor de propiedad

Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic"

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

Detalles del método

Interrumpe todos los vínculos a los libros vinculados. Una vez rotos los vínculos, las fórmulas que hacen referencia a los vínculos de libro se quitan por completo y se reemplazan por los valores recuperados más recientemente.

breakAllLinks(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItem(key)

Obtiene información sobre un libro vinculado por su dirección URL.

getItem(key: string): Excel.LinkedWorkbook;

Parámetros

key

string

Dirección URL del libro vinculado.

Devoluciones

Libro vinculado con la dirección URL especificada.

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Obtiene información sobre un libro vinculado por su dirección URL. Si el libro no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getItemOrNullObject(key: string): Excel.LinkedWorkbook;

Parámetros

key

string

Dirección URL del libro vinculado.

Devoluciones

Libro vinculado con una dirección URL determinada.

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.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedWorkbookCollection;

Parámetros

options

Excel.Interfaces.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Devoluciones

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.LinkedWorkbookCollection;

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

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?: OfficeExtension.LoadOption): Excel.LinkedWorkbookCollection;

Parámetros

propertyNamesAndPaths
OfficeExtension.LoadOption

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

refreshAll()

Realiza una solicitud para actualizar todos los vínculos del libro.

refreshAll(): 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.LinkedWorkbookCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.LinkedWorkbookCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): Excel.Interfaces.LinkedWorkbookCollectionData;

Devoluciones