ExcelScript.RangeAreas interface

Paquete:

ExcelScript

RangeAreas representa una colección de uno o más rangos rectangulares en la misma hoja de cálculo.

Comentarios

Ejemplos

/**
 * This script clears all the cells in the current worksheet that are displaying errors.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range on the current sheet.
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Get the RangeAreas object for each cell with a formula error.
  const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);

  // If there are any error cells, clear them.
  if (errorCells) {
    errorCells.clear();
  }
}

Métodos

addConditionalFormat(type)	Agrega un nuevo formato condicional a la colección con la prioridad primera o superior.
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.
clearAllConditionalFormats()	Borra todos los formatos condicionales activos en el intervalo actual especificado.
convertDataTypeToText()	Convierte todas las celdas de RangeAreas con tipos de datos en texto.
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.
getAddress()	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").
getAddressLocal()	Devuelve la RangeAreas referencia en la configuración regional del usuario.
getAreaCount()	Devuelve el número de intervalos rectangulares que componen este RangeAreas objeto.
getAreas()	Devuelve una colección de intervalos rectangulares que componen este RangeAreas objeto.
getCellCount()	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).
getConditionalFormat(id)	Devuelve un formato condicional identificado por su identificador. Si el objeto de formato condicional no existe, este método devuelve undefined.
getConditionalFormats()	Devuelve una colección de formatos condicionales que intersecan con cualquier celda de este RangeAreas objeto.
getDataValidation()	Devuelve un objeto de validación de datos para todos los intervalos de .RangeAreas
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").
getFormat()	Devuelve un RangeFormat objeto, encapsulando la fuente, el relleno, los bordes, la alineación y otras propiedades de todos los rangos del RangeAreas objeto.
getIntersection(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 undefined.
getIsEntireColumn()	Especifica si todos los intervalos de este RangeAreas objeto representan columnas completas (por ejemplo, "A:C, Q:Z").
getIsEntireRow()	Especifica si todos los intervalos de este RangeAreas objeto representan filas completas (por ejemplo, "1:3, 5:7").
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.
getPredefinedCellStyle()	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.
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, este método devuelve undefined.
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, este método devuelve undefined.
getWorksheet()	Devuelve la hoja de cálculo del objeto actual RangeAreas.
setDirty()	Establece que RangeAreas se va a recalcular cuando se produzca la siguiente actualización.
setPredefinedCellStyle(predefinedCellStyle)	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.

Detalles del método

addConditionalFormat(type)

Agrega un nuevo formato condicional a la colección con la prioridad primera o superior.

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Parámetros

type

ExcelScript.ConditionalFormatType

Tipo de formato condicional que se va a agregar. Vea ExcelScript.ConditionalFormatType para más información.

Devoluciones

ExcelScript.ConditionalFormat

calculate()

Calcula todas las celdas de .RangeAreas

calculate(): void;

Devoluciones

void

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?: ClearApplyTo): void;

Parámetros

applyTo

ExcelScript.ClearApplyTo

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

Devoluciones

void

Ejemplos

/**
 * This script clears all the cells in the current worksheet that are displaying errors.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range on the current sheet.
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Get the RangeAreas object for each cell with a formula error.
  const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);

  // If there are any error cells, clear them.
  if (errorCells) {
    errorCells.clear();
  }
}

clearAllConditionalFormats()

Borra todos los formatos condicionales activos en el intervalo actual especificado.

clearAllConditionalFormats(): void;

Devoluciones

void

convertDataTypeToText()

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

convertDataTypeToText(): void;

Devoluciones

void

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?: RangeCopyType,
            skipBlanks?: boolean,
            transpose?: boolean
        ): void;

Parámetros

sourceRange

ExcelScript.Range | ExcelScript.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

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

getAddress()

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").

getAddress(): string;

Devoluciones

string

getAddressLocal()

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

getAddressLocal(): string;

Devoluciones

string

getAreaCount()

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

getAreaCount(): number;

Devoluciones

number

getAreas()

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

getAreas(): Range[];

Devoluciones

ExcelScript.Range[]

getCellCount()

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

getCellCount(): number;

Devoluciones

number

getConditionalFormat(id)

Devuelve un formato condicional identificado por su identificador. Si el objeto de formato condicional no existe, este método devuelve undefined.

getConditionalFormat(id: string): ConditionalFormat | undefined;

Parámetros

id

string

Identificador del formato condicional.

Devoluciones

ExcelScript.ConditionalFormat | undefined

getConditionalFormats()

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

getConditionalFormats(): ConditionalFormat[];

Devoluciones

ExcelScript.ConditionalFormat[]

getDataValidation()

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

getDataValidation(): DataValidation;

Devoluciones

ExcelScript.DataValidation

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

Devoluciones

ExcelScript.RangeAreas

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

Devoluciones

ExcelScript.RangeAreas

getFormat()

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

getFormat(): RangeFormat;

Devoluciones

ExcelScript.RangeFormat

Ejemplos

/**
 * This script finds and highlights all the cells in the current worksheet that contain a formula.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range on the current sheet.
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Get the RangeAreas object for each cell with a formula.
  const formulaCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas);

  // Add a light blue background to the cells containing formulas.
  formulaCells.getFormat().getFill().setColor("#ADD8E6");
}

getIntersection(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 undefined.

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

Parámetros

anotherRange

ExcelScript.Range | ExcelScript.RangeAreas | string

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

Devoluciones

ExcelScript.RangeAreas

getIsEntireColumn()

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

getIsEntireColumn(): boolean;

Devoluciones

boolean

getIsEntireRow()

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

getIsEntireRow(): boolean;

Devoluciones

boolean

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
        ): 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

ExcelScript.RangeAreas

getPredefinedCellStyle()

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.

getPredefinedCellStyle(): string;

Devoluciones

string

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, este método devuelve undefined.

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

Parámetros

cellType

ExcelScript.SpecialCellType

Tipo de celdas que se van a incluir.

cellValueType

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

ExcelScript.RangeAreas

getTables(fullyContained)

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

getTables(fullyContained?: boolean): Table[];

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

ExcelScript.Table[]

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, este método devuelve undefined.

getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;

Parámetros

valuesOnly

boolean

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

Devoluciones

ExcelScript.RangeAreas

getWorksheet()

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

getWorksheet(): Worksheet;

Devoluciones

ExcelScript.Worksheet

setDirty()

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

setDirty(): void;

Devoluciones

void

setPredefinedCellStyle(predefinedCellStyle)

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.

setPredefinedCellStyle(predefinedCellStyle: string): void;

Parámetros

predefinedCellStyle

string

Devoluciones

void

Ejemplos

/**
 * This script sets the cell style to "warning text"
 * on every cell with a formula error.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the used range in the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const usedRange = sheet.getUsedRange();

  // Get any cells that are displaying errors.
  const errorCells = usedRange.getSpecialCells(
    ExcelScript.SpecialCellType.formulas,
    ExcelScript.SpecialCellValueType.errors
  );

  // Check if there are error cells before proceeding.
  if (errorCells) {
    // Use the built-in warning text style on the error cells.
    errorCells.setPredefinedCellStyle(
      ExcelScript.BuiltInStyle.warningText.toString()
    );
  } else {
    console.log("No formula errors in the worksheet.");
  }
}