Excel.RangeAreas class

Paquete:

excel

RangeAreas representa una colección de uno o más rangos rectangulares en la misma hoja de cálculo. Para obtener información sobre cómo usar rangos no contiguos, lea Trabajar con varios rangos simultáneamente en complementos de Excel.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Propiedades

address	Devuelve la RangeAreas referencia en estilo A1. El valor de dirección contendrá el nombre de la hoja de cálculo de cada bloque rectangular de celdas (por ejemplo, "Sheet1! A1:B4, Sheet1! D1:D4").
addressLocal	Devuelve la RangeAreas referencia en la configuración regional del usuario.
areaCount	Devuelve el número de intervalos rectangulares que componen este RangeAreas objeto.
areas	Devuelve una colección de intervalos rectangulares que componen este RangeAreas objeto.
cellCount	Devuelve el número de celdas del RangeAreas objeto, sumando los recuentos de celdas de todos los rangos rectangulares individuales. Devuelve -1 si el número de celdas es superior a 2^31-1 (2 147 483 647).
conditionalFormats	Devuelve una colección de formatos condicionales que intersecan con cualquier celda de este RangeAreas objeto.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
dataValidation	Devuelve un objeto de validación de datos para todos los intervalos de .RangeAreas
format	Devuelve un RangeFormat objeto, encapsulando la fuente, el relleno, los bordes, la alineación y otras propiedades de todos los rangos del RangeAreas objeto.
isEntireColumn	Especifica si todos los intervalos de este RangeAreas objeto representan columnas completas (por ejemplo, "A:C, Q:Z").
isEntireRow	Especifica si todos los intervalos de este RangeAreas objeto representan filas completas (por ejemplo, "1:3, 5:7").
style	Representa el estilo de todos los rangos de este RangeAreas objeto. Si los estilos de las celdas son incoherentes, null se devolverán. En el caso de los estilos personalizados, se devolverá el nombre del estilo. Para los estilos integrados, se devolverá una cadena que representa un valor en la BuiltInStyle enumeración.
worksheet	Devuelve la hoja de cálculo del objeto actual RangeAreas.

Métodos

calculate()	Calcula todas las celdas de .RangeAreas
clear(applyTo)	Borra los valores, el formato, el relleno, el borde y otras propiedades en cada una de las áreas que componen este RangeAreas objeto.
clear(applyToString)	Borra los valores, el formato, el relleno, el borde y otras propiedades en cada una de las áreas que componen este RangeAreas objeto.
clearOrResetContents()	Borra los valores de las celdas de los rangos, teniendo especial en cuenta las celdas que contienen controles. Si los intervalos solo contienen valores en blanco y controles establecidos en su valor predeterminado, se quitan los valores y el formato de control. De lo contrario, establece las celdas con controles en su valor predeterminado y borra los valores de las otras celdas de los rangos.
convertDataTypeToText()	Convierte todas las celdas de RangeAreas con tipos de datos en texto.
convertToLinkedDataType(serviceID, languageCulture)	Convierte todas las celdas de RangeAreas en tipos de datos vinculados.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Copia los datos de celda o el formato del intervalo de origen o RangeAreas al actual RangeAreas. El destino RangeAreas puede tener un tamaño diferente al intervalo de origen o RangeAreas. El destino se expandirá automáticamente si es menor que el origen.
copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)	Copia los datos de celda o el formato del intervalo de origen o RangeAreas al actual RangeAreas. El destino RangeAreas puede tener un tamaño diferente al intervalo de origen o RangeAreas. El destino se expandirá automáticamente si es menor que el origen.
getEntireColumn()	Devuelve un RangeAreas objeto que representa todas las columnas de RangeAreas (por ejemplo, si el actual RangeAreas representa las celdas "B4:E11, H2", devuelve un RangeAreas que representa las columnas "B:E, H:H").
getEntireRow()	Devuelve un RangeAreas objeto que representa todas las filas de RangeAreas (por ejemplo, si el actual RangeAreas representa las celdas "B4:E11", devuelve un RangeAreas que representa las filas "4:11").
getIntersection(anotherRange)	Devuelve el RangeAreas objeto que representa la intersección de los intervalos especificados o RangeAreas. Si no se encuentra ninguna intersección, se producirá un ItemNotFound error.
getIntersectionOrNullObject(anotherRange)	Devuelve el RangeAreas objeto que representa la intersección de los intervalos especificados o RangeAreas. Si no se encuentra ninguna intersección, 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).
getOffsetRangeAreas(rowOffset, columnOffset)	Devuelve un RangeAreas objeto que se desplaza por el desplazamiento de fila y columna específico. La dimensión del objeto devuelto RangeAreas coincidirá con el objeto original. Si el resultado RangeAreas se fuerza fuera de los límites de la cuadrícula de la hoja de cálculo, se producirá un error.
getSpecialCells(cellType, cellValueType)	Devuelve un RangeAreas objeto que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial que coincida con los criterios se produce un error.
getSpecialCells(cellTypeString, cellValueTypeString)	Devuelve un RangeAreas objeto que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial que coincida con los criterios se produce un error.
getSpecialCellsOrNullObject(cellType, cellValueType)	Devuelve un RangeAreas objeto que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial que coincida con los criterios, 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).
getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)	Devuelve un RangeAreas objeto que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial que coincida con los criterios, 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).
getTables(fullyContained)	Devuelve una colección con ámbito de tablas que se superponen con cualquier intervalo de este RangeAreas objeto.
getUsedRangeAreas(valuesOnly)	Devuelve el objeto usado RangeAreas que comprende todas las áreas usadas de intervalos rectangulares individuales en el RangeAreas objeto . Si no hay celdas usadas dentro de RangeAreas, se producirá el ItemNotFound error.
getUsedRangeAreasOrNullObject(valuesOnly)	Devuelve el objeto usado RangeAreas que comprende todas las áreas usadas de intervalos rectangulares individuales en el RangeAreas objeto . Si no hay celdas usadas dentro de RangeAreas, 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.
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.
setDirty()	Establece que RangeAreas se va a recalcular cuando se produzca la siguiente actualización.
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.RangeAreas es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.RangeAreasData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
track()	Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.
untrack()	Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

address

Devuelve la RangeAreas referencia en estilo A1. El valor de dirección contendrá el nombre de la hoja de cálculo de cada bloque rectangular de celdas (por ejemplo, "Sheet1! A1:B4, Sheet1! D1:D4").

readonly address: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

addressLocal

Devuelve la RangeAreas referencia en la configuración regional del usuario.

readonly addressLocal: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

areaCount

Devuelve el número de intervalos rectangulares que componen este RangeAreas objeto.

readonly areaCount: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

areas

Devuelve una colección de intervalos rectangulares que componen este RangeAreas objeto.

readonly areas: Excel.RangeCollection;

Valor de propiedad

Excel.RangeCollection

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

cellCount

Devuelve el número de celdas del RangeAreas objeto, sumando los recuentos de celdas de todos los rangos rectangulares individuales. Devuelve -1 si el número de celdas es superior a 2^31-1 (2 147 483 647).

readonly cellCount: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

conditionalFormats

Devuelve una colección de formatos condicionales que intersecan con cualquier celda de este RangeAreas objeto.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Valor de propiedad

Excel.ConditionalFormatCollection

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

dataValidation

Devuelve un objeto de validación de datos para todos los intervalos de .RangeAreas

readonly dataValidation: Excel.DataValidation;

Valor de propiedad

Excel.DataValidation

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

format

Devuelve un RangeFormat objeto, encapsulando la fuente, el relleno, los bordes, la alineación y otras propiedades de todos los rangos del RangeAreas objeto.

readonly format: Excel.RangeFormat;

Valor de propiedad

Excel.RangeFormat

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml

await Excel.run(async (context) => {

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const usedRange = sheet.getUsedRange();

    // Find the ranges with formulas.
    const formulaRanges = usedRange.getSpecialCells("Formulas");
    formulaRanges.format.fill.color = "lightgreen";

    await context.sync();
});

isEntireColumn

Especifica si todos los intervalos de este RangeAreas objeto representan columnas completas (por ejemplo, "A:C, Q:Z").

readonly isEntireColumn: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

isEntireRow

Especifica si todos los intervalos de este RangeAreas objeto representan filas completas (por ejemplo, "1:3, 5:7").

readonly isEntireRow: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

style

Representa el estilo de todos los rangos de este RangeAreas objeto. Si los estilos de las celdas son incoherentes, null se devolverán. En el caso de los estilos personalizados, se devolverá el nombre del estilo. Para los estilos integrados, se devolverá una cadena que representa un valor en la BuiltInStyle enumeración.

style: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

worksheet

Devuelve la hoja de cálculo del objeto actual RangeAreas.

readonly worksheet: Excel.Worksheet;

Valor de propiedad

Excel.Worksheet

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Detalles del método

calculate()

Calcula todas las celdas de .RangeAreas

calculate(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

clear(applyTo)

Borra los valores, el formato, el relleno, el borde y otras propiedades en cada una de las áreas que componen este RangeAreas objeto.

clear(applyTo?: Excel.ClearApplyTo): void;

Parámetros

applyTo

Excel.ClearApplyTo

Opcional. Determina el tipo de acción de borrado. Vea Excel.ClearApplyTo para más información. El valor predeterminado es "All".

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

clear(applyToString)

Borra los valores, el formato, el relleno, el borde y otras propiedades en cada una de las áreas que componen este RangeAreas objeto.

clear(applyToString?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;

Parámetros

applyToString

"All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"

Opcional. Determina el tipo de acción de borrado. Vea Excel.ClearApplyTo para más información. El valor predeterminado es "All".

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

clearOrResetContents()

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.

Borra los valores de las celdas de los rangos, teniendo especial en cuenta las celdas que contienen controles. Si los intervalos solo contienen valores en blanco y controles establecidos en su valor predeterminado, se quitan los valores y el formato de control. De lo contrario, establece las celdas con controles en su valor predeterminado y borra los valores de las otras celdas de los rangos.

clearOrResetContents(): void;

Devoluciones

void

Comentarios

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

convertDataTypeToText()

Convierte todas las celdas de RangeAreas con tipos de datos en texto.

convertDataTypeToText(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

convertToLinkedDataType(serviceID, languageCulture)

Convierte todas las celdas de RangeAreas en tipos de datos vinculados.

convertToLinkedDataType(serviceID: number, languageCulture: string): void;

Parámetros

serviceID

number

Identificador de servicio que se usará para consultar los datos.

languageCulture

string

Referencia cultural del lenguaje para consultar el servicio.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copia los datos de celda o el formato del intervalo de origen o RangeAreas al actual RangeAreas. El destino RangeAreas puede tener un tamaño diferente al intervalo de origen o RangeAreas. El destino se expandirá automáticamente si es menor que el origen.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;

Parámetros

sourceRange

Excel.Range | Excel.RangeAreas | string

Intervalo de origen o RangeAreas desde el que se va a copiar. Cuando el origen RangeAreas tiene varios intervalos, su formulario debe poder crearse quitando filas o columnas completas de un intervalo rectangular.

copyType

Excel.RangeCopyType

Tipo de datos de celda o formato que se va a copiar. El valor predeterminado es "All".

skipBlanks

boolean

True si se omiten las celdas en blanco en el rango de origen o RangeAreas. El valor predeterminado es false.

transpose

boolean

True si se van a transponer las celdas en el destino RangeAreas. El valor predeterminado es false.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

Copia los datos de celda o el formato del intervalo de origen o RangeAreas al actual RangeAreas. El destino RangeAreas puede tener un tamaño diferente al intervalo de origen o RangeAreas. El destino se expandirá automáticamente si es menor que el origen.

copyFrom(sourceRange: Range | RangeAreas | string, copyTypeString?: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths", skipBlanks?: boolean, transpose?: boolean): void;

Parámetros

sourceRange

Excel.Range | Excel.RangeAreas | string

Intervalo de origen o RangeAreas desde el que se va a copiar. Cuando el origen RangeAreas tiene varios intervalos, su formulario debe poder crearse quitando filas o columnas completas de un intervalo rectangular.

copyTypeString

"All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths"

Tipo de datos de celda o formato que se va a copiar. El valor predeterminado es "All".

skipBlanks

boolean

True si se omiten las celdas en blanco en el rango de origen o RangeAreas. El valor predeterminado es false.

transpose

boolean

True si se van a transponer las celdas en el destino RangeAreas. El valor predeterminado es false.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getEntireColumn()

Devuelve un RangeAreas objeto que representa todas las columnas de RangeAreas (por ejemplo, si el actual RangeAreas representa las celdas "B4:E11, H2", devuelve un RangeAreas que representa las columnas "B:E, H:H").

getEntireColumn(): Excel.RangeAreas;

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getEntireRow()

Devuelve un RangeAreas objeto que representa todas las filas de RangeAreas (por ejemplo, si el actual RangeAreas representa las celdas "B4:E11", devuelve un RangeAreas que representa las filas "4:11").

getEntireRow(): Excel.RangeAreas;

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getIntersection(anotherRange)

Devuelve el RangeAreas objeto que representa la intersección de los intervalos especificados o RangeAreas. Si no se encuentra ninguna intersección, se producirá un ItemNotFound error.

getIntersection(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;

Parámetros

anotherRange

Excel.Range | Excel.RangeAreas | string

Intervalo, RangeAreas objeto o dirección de intervalo que se usará para determinar la intersección.

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getIntersectionOrNullObject(anotherRange)

Devuelve el RangeAreas objeto que representa la intersección de los intervalos especificados o RangeAreas. Si no se encuentra ninguna intersección, 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).

getIntersectionOrNullObject(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;

Parámetros

anotherRange

Excel.Range | Excel.RangeAreas | string

Intervalo, RangeAreas objeto o dirección que se usará para determinar la intersección.

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getOffsetRangeAreas(rowOffset, columnOffset)

Devuelve un RangeAreas objeto que se desplaza por el desplazamiento de fila y columna específico. La dimensión del objeto devuelto RangeAreas coincidirá con el objeto original. Si el resultado RangeAreas se fuerza fuera de los límites de la cuadrícula de la hoja de cálculo, se producirá un error.

getOffsetRangeAreas(rowOffset: number, columnOffset: number): Excel.RangeAreas;

Parámetros

rowOffset

number

Número de filas (positivo, negativo o 0) por el que se va a desplazar.RangeAreas Los valores positivos desplazan hacia abajo, mientras que los negativos lo hacen hacia arriba.

columnOffset

number

Número de columnas (positivo, negativo o 0) por el que se va a desplazar.RangeAreas Los valores positivos desplazan hacia la derecha, mientras que los negativos lo hacen hacia la izquierda.

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getSpecialCells(cellType, cellValueType)

Devuelve un RangeAreas objeto que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial que coincida con los criterios se produce un error.

getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Parámetros

cellType

Excel.SpecialCellType

Tipo de celdas que se van a incluir.

cellValueType

Excel.SpecialCellValueType

Si cellType es o constantsformulas, este argumento se usa para determinar qué tipos de celdas se van a incluir en el resultado. Estos valores se pueden combinar para devolver más de un tipo. El valor predeterminado es seleccionar todas las constantes o fórmulas, sea cual sea el tipo.

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getSpecialCells(cellTypeString, cellValueTypeString)

Devuelve un RangeAreas objeto que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial que coincida con los criterios se produce un error.

getSpecialCells(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueTypeString?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Parámetros

cellTypeString

"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

Tipo de celdas que se van a incluir.

cellValueTypeString

"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

Si cellType es o constantsformulas, este argumento se usa para determinar qué tipos de celdas se van a incluir en el resultado. Estos valores se pueden combinar para devolver más de un tipo. El valor predeterminado es seleccionar todas las constantes o fórmulas, sea cual sea el tipo.

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellType, cellValueType)

Devuelve un RangeAreas objeto que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial que coincida con los criterios, 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).

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Parámetros

cellType

Excel.SpecialCellType

Tipo de celdas que se van a incluir.

cellValueType

Excel.SpecialCellValueType

Si cellType es o constantsformulas, este argumento se usa para determinar qué tipos de celdas se van a incluir en el resultado. Estos valores se pueden combinar para devolver más de un tipo. El valor predeterminado es seleccionar todas las constantes o fórmulas, sea cual sea el tipo.

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)

Devuelve un RangeAreas objeto que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial que coincida con los criterios, 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).

getSpecialCellsOrNullObject(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueTypeString?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Parámetros

cellTypeString

"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

Tipo de celdas que se van a incluir.

cellValueTypeString

"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

Si cellType es o constantsformulas, este argumento se usa para determinar qué tipos de celdas se van a incluir en el resultado. Estos valores se pueden combinar para devolver más de un tipo. El valor predeterminado es seleccionar todas las constantes o fórmulas, sea cual sea el tipo.

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getTables(fullyContained)

Devuelve una colección con ámbito de tablas que se superponen con cualquier intervalo de este RangeAreas objeto.

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

Parámetros

fullyContained

boolean

Si truees , devuelve solo las tablas que están totalmente contenidas dentro de los límites del intervalo. El valor predeterminado es false.

Devoluciones

Excel.TableScopedCollection

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getUsedRangeAreas(valuesOnly)

Devuelve el objeto usado RangeAreas que comprende todas las áreas usadas de intervalos rectangulares individuales en el RangeAreas objeto . Si no hay celdas usadas dentro de RangeAreas, se producirá el ItemNotFound error.

getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;

Parámetros

valuesOnly

boolean

Si solo se deben tener en cuenta las celdas con valores como celdas usadas. El valor predeterminado es false.

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getUsedRangeAreasOrNullObject(valuesOnly)

Devuelve el objeto usado RangeAreas que comprende todas las áreas usadas de intervalos rectangulares individuales en el RangeAreas objeto . Si no hay celdas usadas dentro de RangeAreas, 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).

getUsedRangeAreasOrNullObject(valuesOnly?: boolean): Excel.RangeAreas;

Parámetros

valuesOnly

boolean

Si solo se deben tener en cuenta las celdas con valores como celdas usadas.

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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.RangeAreasLoadOptions): Excel.RangeAreas;

Parámetros

options

Excel.Interfaces.RangeAreasLoadOptions

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

Devoluciones

Excel.RangeAreas

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

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

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

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

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.RangeAreasUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties

Excel.Interfaces.RangeAreasUpdateData

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.RangeAreas): void;

Parámetros

properties

Excel.RangeAreas

Devoluciones

void

setDirty()

Establece que RangeAreas se va a recalcular cuando se produzca la siguiente actualización.

setDirty(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

toJSON(): Excel.Interfaces.RangeAreasData;

Devoluciones

Excel.Interfaces.RangeAreasData

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.

track(): Excel.RangeAreas;

Devoluciones

Excel.RangeAreas

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): Excel.RangeAreas;

Devoluciones

Excel.RangeAreas