Excel.RangeView class

  • Referencia
Paquete:
excel

RangeView representa un conjunto de celdas visibles del intervalo primario.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

Propiedades

cellAddresses

Representa las direcciones de celda de RangeView.
columnCount

Número de columnas visibles.
context

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

Representa la fórmula en notación de estilo A1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.
formulasLocal

Representa la fórmula en notación de estilo A1, en el idioma del usuario y en la configuración regional del formato numérico. Por ejemplo, la fórmula "=SUM(A1, 1.5)" en inglés se convertiría en "=SUMME(A1; 1,5)" en alemán. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.
formulasR1C1

Representa la fórmula en notación de estilo R1C1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.
index

Devuelve un valor que representa el índice de RangeView.
numberFormat

Representa el código de formato numérico de Excel para la celda especificada.
rowCount

Número de filas visibles.
rows

Representa una colección de vistas de intervalo asociadas a este.
text

Valores de texto del intervalo especificado. El valor Text no dependerá del ancho de la celda. La sustitución del signo # que tiene lugar en la interfaz de usuario de Excel no afectará al valor de texto devuelto por la API.
values

Representa los valores sin formato de la vista del intervalo especificado. Los datos devueltos pueden ser de tipo cadena, número o booleano. Las celdas que contienen un error devolverán la cadena de error.
valueTypes

Representa el tipo de datos de cada celda.

Métodos

getRange()

Obtiene el intervalo primario asociado al actual RangeView.
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.
set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
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.RangeView original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.RangeViewData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

cellAddresses

Representa las direcciones de celda de RangeView.

readonly cellAddresses: any[][];

Valor de propiedad

any[][]

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

columnCount

Número de columnas visibles.

readonly columnCount: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

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

formulas

Representa la fórmula en notación de estilo A1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.

formulas: any[][];

Valor de propiedad

any[][]

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

formulasLocal

Representa la fórmula en notación de estilo A1, en el idioma del usuario y en la configuración regional del formato numérico. Por ejemplo, la fórmula "=SUM(A1, 1.5)" en inglés se convertiría en "=SUMME(A1; 1,5)" en alemán. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.

formulasLocal: any[][];

Valor de propiedad

any[][]

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

formulasR1C1

Representa la fórmula en notación de estilo R1C1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.

formulasR1C1: any[][];

Valor de propiedad

any[][]

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

index

Devuelve un valor que representa el índice de RangeView.

readonly index: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

numberFormat

Representa el código de formato numérico de Excel para la celda especificada.

numberFormat: any[][];

Valor de propiedad

any[][]

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

rowCount

Número de filas visibles.

readonly rowCount: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

rows

Representa una colección de vistas de intervalo asociadas a este.

readonly rows: Excel.RangeViewCollection;

Valor de propiedad

Excel.RangeViewCollection

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

text

Valores de texto del intervalo especificado. El valor Text no dependerá del ancho de la celda. La sustitución del signo # que tiene lugar en la interfaz de usuario de Excel no afectará al valor de texto devuelto por la API.

readonly text: string[][];

Valor de propiedad

string[][]

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

values

Representa los valores sin formato de la vista del intervalo especificado. Los datos devueltos pueden ser de tipo cadena, número o booleano. Las celdas que contienen un error devolverán la cadena de error.

values: any[][];

Valor de propiedad

any[][]

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

valueTypes

Representa el tipo de datos de cada celda.

readonly valueTypes: Excel.RangeValueType[][];

Valor de propiedad

Excel.RangeValueType[][]

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

Detalles del método

getRange()

Obtiene el intervalo primario asociado al actual RangeView.

getRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

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.RangeViewLoadOptions): Excel.RangeView;

Parámetros

options
Excel.Interfaces.RangeViewLoadOptions

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

Devoluciones

Excel.RangeView

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

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

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

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

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

set(properties: Interfaces.RangeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties
Excel.Interfaces.RangeViewUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options
OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Excel.RangeView): void;

Parámetros

properties
Excel.RangeView

Devoluciones

void

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

toJSON(): Excel.Interfaces.RangeViewData;

Devoluciones

Excel.Interfaces.RangeViewData