Excel.NamedSheetViewCollection class

Paquete:

excel

Representa la colección de vistas de hoja de la hoja de cálculo.

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.
items	Obtiene los elementos secundarios cargados en esta colección.

Métodos

add(name)	Crea una nueva vista de hoja con el nombre especificado.
enterTemporary()	Crea y activa una nueva vista de hoja temporal. Las vistas temporales se quitan al cerrar la aplicación, salir de la vista temporal con el método exit o cambiar a otra vista de hoja. También se puede acceder a la vista de hoja temporal con la cadena vacía (""), si existe la vista temporal.
exit()	Sale de la vista de hoja actualmente activa.
getActive()	Obtiene la vista de hoja actualmente activa de la hoja.
getCount()	Obtiene el número de vistas de hoja de esta hoja de cálculo. Incluye la vista de hoja temporal si existe.
getItem(key)	Obtiene una vista de hoja con su nombre.
getItemAt(index)	Obtiene una vista de hoja por su índice en la colección.
getItemOrNullObject(key)	Obtiene una vista de hoja con su nombre. Si el objeto de vista de hoja 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.
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.NamedSheetViewCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.NamedSheetViewCollectionData) 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

Excel.RequestContext

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.NamedSheetView[];

Valor de propiedad

Excel.NamedSheetView[]

Detalles del método

add(name)

Crea una nueva vista de hoja con el nombre especificado.

add(name: string): Excel.NamedSheetView;

Parámetros

name

string

Nombre de la vista de hoja que se va a crear. Produce un error cuando el nombre proporcionado ya existe, está vacío o es un nombre reservado por la hoja de cálculo.

Devoluciones

Excel.NamedSheetView

Objeto de vista de hoja recién creado.

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

enterTemporary()

Crea y activa una nueva vista de hoja temporal. Las vistas temporales se quitan al cerrar la aplicación, salir de la vista temporal con el método exit o cambiar a otra vista de hoja. También se puede acceder a la vista de hoja temporal con la cadena vacía (""), si existe la vista temporal.

enterTemporary(): Excel.NamedSheetView;

Devoluciones

Excel.NamedSheetView

Objeto de vista de hoja recién creado.

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

exit()

Sale de la vista de hoja actualmente activa.

exit(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

getActive()

Obtiene la vista de hoja actualmente activa de la hoja.

getActive(): Excel.NamedSheetView;

Devoluciones

Excel.NamedSheetView

Vista de hoja actualmente activa para esta hoja de cálculo.

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

getCount()

Obtiene el número de vistas de hoja de esta hoja de cálculo. Incluye la vista de hoja temporal si existe.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

OfficeExtension.ClientResult<number>

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItem(key)

Obtiene una vista de hoja con su nombre.

getItem(key: string): Excel.NamedSheetView;

Parámetros

key

string

Nombre que distingue mayúsculas de minúsculas de la vista de hoja. Use la cadena vacía ("") para obtener la vista de hoja temporal, si existe la vista temporal.

Devoluciones

Excel.NamedSheetView

Vista de hoja con el nombre especificado o la vista temporal si se proporcionó una cadena vacía. Si no hay ninguna vista temporal actual y se proporcionó una cadena vacía, se produce un ItemNotFound error.

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItemAt(index)

Obtiene una vista de hoja por su índice en la colección.

getItemAt(index: number): Excel.NamedSheetView;

Parámetros

index

number

Índice del objeto de vista de hoja de la colección.

Devoluciones

Excel.NamedSheetView

Vista de hoja en el índice especificado.

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene una vista de hoja con su nombre. Si el objeto de vista de hoja 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.NamedSheetView;

Parámetros

key

string

Nombre que distingue mayúsculas de minúsculas de la vista de hoja. Use la cadena vacía ("") para obtener la vista de hoja temporal, si existe la vista temporal.

Devoluciones

Excel.NamedSheetView

Vista de hoja con el nombre especificado o la vista temporal si se proporcionó una cadena vacía.

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

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

Parámetros

options

Excel.Interfaces.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Devoluciones

Excel.NamedSheetViewCollection

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

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

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

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

Excel.NamedSheetViewCollection

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

toJSON(): Excel.Interfaces.NamedSheetViewCollectionData;

Devoluciones

Excel.Interfaces.NamedSheetViewCollectionData