Excel.NamedSheetView class

Representa una vista de hoja con nombre de una hoja de cálculo. Una vista de hoja almacena las reglas de ordenación y filtro de una hoja de cálculo determinada. Cada vista de hoja (incluso una vista de hoja temporal) tiene un nombre único con ámbito de hoja de cálculo que se usa para acceder a la vista.

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.

name

Obtiene o establece el nombre de la vista de hoja. El nombre de la vista de hoja temporal es la cadena vacía (""). Asignar un nombre a la vista mediante la propiedad name hace que se guarde la vista de hoja.

Métodos

activate()

Activa esta vista de hoja. Esto equivale a usar "Cambiar a" en la interfaz de usuario de Excel.

delete()

Quita la vista de hoja de la hoja de cálculo.

duplicate(name)

Crea una copia de esta vista de hoja.

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 Excel.NamedSheetView original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.NamedSheetViewData) 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

name

Obtiene o establece el nombre de la vista de hoja. El nombre de la vista de hoja temporal es la cadena vacía (""). Asignar un nombre a la vista mediante la propiedad name hace que se guarde la vista de hoja.

name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

Detalles del método

activate()

Activa esta vista de hoja. Esto equivale a usar "Cambiar a" en la interfaz de usuario de Excel.

activate(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

delete()

Quita la vista de hoja de la hoja de cálculo.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

duplicate(name)

Crea una copia de esta vista de hoja.

duplicate(name?: string): Excel.NamedSheetView;

Parámetros

name

string

Nombre de la vista de hoja duplicada. Si no se proporciona ningún nombre, se generará uno.

Devoluciones

Nueva vista de hoja duplicada.

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.NamedSheetViewLoadOptions): Excel.NamedSheetView;

Parámetros

options
Excel.Interfaces.NamedSheetViewLoadOptions

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

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?: {
            select?: string;
            expand?: string;
        }): Excel.NamedSheetView;

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

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 Excel.NamedSheetView original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.NamedSheetViewData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.NamedSheetViewData;

Devoluciones