ExcelScript.Range interface

Paquete:

ExcelScript

Range representa un conjunto de una o varias celdas contiguas, como una celda, una fila, una columna o un bloque de celdas.

Comentarios

Ejemplos

/**
 * This script logs the address of the used range in the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let currentWorksheet = workbook.getActiveWorksheet();

  // Get the range containing all the cells with data or formatting.
  let usedRange = currentWorksheet.getUsedRange();

  // Log the range's address to the console.
  console.log(usedRange.getAddress());
}

Métodos

addConditionalFormat(type)	Agrega un nuevo formato condicional a la colección con la prioridad primera o superior.
autoFill(destinationRange, autoFillType)	Rellena un intervalo desde el intervalo actual hasta el intervalo de destino mediante la lógica de autorrellenar especificada. El intervalo de destino puede ser null o puede extender el intervalo de origen horizontal o verticalmente. No se admiten intervalos de discontiguous.
calculate()	Calcula un rango de celdas en una hoja de cálculo.
clear(applyTo)	Borra valores de rango, formato, relleno, borde, etc.
clearAllConditionalFormats()	Borra todos los formatos condicionales activos en el intervalo actual especificado.
convertDataTypeToText()	Convierte las celdas de rango 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 intervalo actual. El intervalo de destino puede tener un tamaño diferente al intervalo de origen o RangeAreas. El destino se expande automáticamente si es menor que el origen. Nota: Al igual que la funcionalidad de copia en la interfaz de usuario de Excel, si el intervalo de destino es un múltiplo exacto mayor que el intervalo de origen en filas o columnas, el contenido de origen se replica varias veces. Por ejemplo, una copia de intervalo 2x2 en un intervalo de 2x6 dará como resultado 3 copias del intervalo 2x2 original.
delete(shift)	Elimina las celdas asociadas al rango.
find(text, criteria)	Busca la cadena especificada, según los criterios especificados. Si el rango actual es mayor que una sola celda, la búsqueda se limitará a ese rango; de lo contrario, la búsqueda cubrirá toda la hoja a partir de esa celda. Si no hay ninguna coincidencia, este método devuelve undefined.
flashFill()	Realiza un relleno flash en el intervalo actual. El relleno flash rellena automáticamente los datos cuando detecta un patrón, por lo que el intervalo debe ser un único rango de columnas y tener datos alrededor de él para encontrar un patrón.
getAbsoluteResizedRange(numRows, numColumns)	Obtiene un Range objeto con la misma celda superior izquierda que el objeto actual Range , pero con los números especificados de filas y columnas.
getAddress()	Especifica la referencia de rango en estilo A1. El valor de dirección contiene la referencia de hoja (por ejemplo, "Sheet1! A1:B4").
getAddressLocal()	Representa la referencia de intervalo para el intervalo especificado en el idioma del usuario.
getBoundingRect(anotherRange)	Obtiene el objeto de intervalo más pequeño que abarca los intervalos especificados. Por ejemplo, el GetBoundingRect de "B2:C5" y "D10:E15" es "B2:E15".
getCell(row, column)	Obtiene el objeto de intervalo que contiene la celda en función de los números de fila y columna. La celda puede estar fuera de los límites de su rango primario, siempre y cuando permanezca dentro de la cuadrícula de la hoja de cálculo. La celda devuelta se ubica con respecto a la celda superior izquierda del intervalo.
getCellCount()	Especifica el número de celdas del rango. Esta API devolverá -1 si el recuento de celdas supera 2^31-1 (2 147 483 647).
getColumn(column)	Obtiene una columna contenida en el intervalo.
getColumnCount()	Especifica el número total de columnas del intervalo.
getColumnHidden()	Representa si todas las columnas del intervalo actual están ocultas. El valor es true cuando todas las columnas de un intervalo están ocultas. El valor es false cuando no se oculta ninguna columna del intervalo. El valor es null cuando algunas columnas de un rango están ocultas y otras columnas del mismo rango no están ocultas.
getColumnIndex()	Especifica el número de columna de la primera celda del intervalo. Indizado con cero.
getColumnsAfter(count)	Obtiene un determinado número de columnas a la derecha del objeto actual Range .
getColumnsBefore(count)	Obtiene un determinado número de columnas a la izquierda del objeto actual Range .
getConditionalFormat(id)	Devuelve un formato condicional identificado por su identificador. Si el objeto de formato condicional no existe, este método devuelve undefined.
getConditionalFormats()	La colección de ConditionalFormats que interseca el intervalo.
getDataValidation()	Devuelve un objeto de validación de datos.
getDirectPrecedents()	Devuelve un WorkbookRangeAreas objeto que representa el rango que contiene todas las celdas precedentes directas de un rango especificado en la misma hoja de cálculo o en varias hojas de cálculo.
getEntireColumn()	Obtiene un objeto que representa toda la columna del rango (por ejemplo, si el rango actual representa las celdas "B4:E11", es getEntireColumn un rango que representa las columnas "B:E").
getEntireRow()	Obtiene un objeto que representa toda la fila del rango (por ejemplo, si el rango actual representa las celdas "B4:E11", es GetEntireRow un rango que representa las filas "4:11").
getExtendedRange(direction, activeCell)	Devuelve un objeto de rango que incluye el intervalo actual y hasta el borde del intervalo, en función de la dirección proporcionada. Esto coincide con el comportamiento de la tecla Ctrl+Mayús+Flecha en la interfaz de usuario de Excel en Windows.
getFormat()	Devuelve un objeto de formato que encapsula la fuente, el relleno, los bordes, la alineación y otras propiedades del rango.
getFormula()	Representa la fórmula de celda en notación de estilo A1. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).
getFormulaLocal()	Representa la fórmula de celda en notación de estilo A1, en la configuración regional de formato de número y idioma del usuario. Por ejemplo, la fórmula "=SUM(A1, 1.5)" en inglés se convertiría en "=SUMME(A1; 1,5)" en alemán. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).
getFormulaR1C1()	Representa la fórmula de celda en la notación de estilo R1C1. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).
getFormulas()	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.
getFormulasLocal()	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.
getFormulasR1C1()	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.
getHasSpill()	Indica si todas las celdas tienen un borde de desbordamiento. Devuelve true si todas las celdas tienen un borde de derrame o false si todas las celdas no tienen un borde de desbordamiento. Devuelve null si hay celdas con y sin bordes de desbordamiento dentro del intervalo.
getHeight()	Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde superior del rango hasta el borde inferior del intervalo.
getHidden()	Representa si todas las celdas del rango actual están ocultas. El valor es true cuando todas las celdas de un rango están ocultas. El valor es false cuando no se oculta ninguna celda del rango. El valor es null cuando algunas celdas de un rango están ocultas y otras celdas del mismo rango no están ocultas.
getHyperlink()	Representa el hipervínculo del intervalo actual.
getImage()	Representa el intervalo como una imagen png codificada en base64.
getIntersection(anotherRange)	Obtiene el objeto de rango que representa la intersección rectangular de los rangos especificados. Si no se encuentra ninguna intersección, este método devuelve undefined.
getIsEntireColumn()	Representa si el intervalo actual es una columna completa.
getIsEntireRow()	Representa si el intervalo actual es una fila completa.
getLastCell()	Obtiene la última celda del intervalo. Por ejemplo, la última celda de "B2:D5" es "D5".
getLastColumn()	Obtiene la última columna del intervalo. Por ejemplo, la última columna de "B2:D5" es "D2:D5".
getLastRow()	Obtiene la última fila del intervalo. Por ejemplo, la última fila de "B2:D5" es "B5:D5".
getLeft()	Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde izquierdo de la hoja de cálculo hasta el borde izquierdo del rango.
getLinkedDataTypeState()	Representa el estado del tipo de datos de la celda.
getLinkedDataTypeStates()	Indica el estado del tipo de datos de cada celda.
getMergedAreas()	Devuelve un RangeAreas objeto que representa las áreas combinadas de este intervalo. Tenga en cuenta que si el recuento de áreas combinadas en este intervalo es superior a 512, este método no devolverá el resultado. Si el RangeAreas objeto no existe, esta función devuelve undefined.
getNumberFormat()	Representa el código de formato de número de celda de Excel para el intervalo especificado. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).
getNumberFormatCategories()	Representa la categoría de formato numérico de cada celda.
getNumberFormatCategory()	Especifica la categoría de formato de número de la primera celda del rango (representada por el índice de fila de 0 y el índice de columna de 0).
getNumberFormatLocal()	Representa el código de formato de número de celda de Excel para el intervalo especificado, en función de la configuración de idioma del usuario. Excel no realiza ninguna coerción de idioma o formato al obtener o establecer la numberFormatLocal propiedad. Cualquier texto devuelto usa las cadenas con formato local en función del idioma especificado en la configuración del sistema. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).
getNumberFormats()	Representa el código de formato de número de Excel para el intervalo especificado.
getNumberFormatsLocal()	Representa el código de formato de número de Excel para el intervalo especificado, en función de la configuración de idioma del usuario. Excel no realiza ninguna coerción de idioma o formato al obtener o establecer la numberFormatLocal propiedad. Cualquier texto devuelto usa las cadenas con formato local en función del idioma especificado en la configuración del sistema.
getOffsetRange(rowOffset, columnOffset)	Obtiene un objeto que representa un intervalo desplazado con respecto al intervalo especificado. La dimensión del rango devuelto coincidirá con este rango. Si el rango resultante se fuerza más allá de los límites de la cuadrícula de la hoja de cálculo, se producirá un error.
getPivotTables(fullyContained)	Obtiene una colección con ámbito de tablas dinámicas que se superponen con el intervalo.
getPredefinedCellStyle()	Representa el estilo del rango actual. 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.
getRangeEdge(direction, activeCell)	Devuelve un objeto de rango que es la celda perimetral de la región de datos que corresponde a la dirección proporcionada. Esto coincide con el comportamiento de la tecla Ctrl+Flecha en la interfaz de usuario de Excel en Windows.
getResizedRange(deltaRows, deltaColumns)	Obtiene un Range objeto similar al objeto actual Range , pero con su esquina inferior derecha expandida (o contratada) por algún número de filas y columnas.
getRow(row)	Obtiene una fila contenida en el intervalo.
getRowCount()	Devuelve el número total de filas del intervalo.
getRowHidden()	Representa si todas las filas del intervalo actual están ocultas. El valor es true cuando todas las filas de un intervalo están ocultas. El valor es false cuando no se oculta ninguna fila del intervalo. El valor es null cuando algunas filas de un rango están ocultas y otras filas del mismo rango no están ocultas.
getRowIndex()	Devuelve el número de fila de la primera celda del intervalo. Indizado con cero.
getRowsAbove(count)	Obtiene un número determinado de filas por encima del objeto actual Range .
getRowsBelow(count)	Obtiene un número determinado de filas por debajo del objeto actual Range .
getSavedAsArray()	Representa si todas las celdas se guardarían como una fórmula de matriz. Devuelve true si todas las celdas se guardarían como una fórmula de matriz o false si todas las celdas no se guardarían como una fórmula de matriz. Devuelve null si algunas celdas se guardarían como una fórmula de matriz y otras no lo serían.
getSort()	Representa la ordenación del intervalo del intervalo actual.
getSpecialCells(cellType, cellValueType)	Obtiene el RangeAreas objeto, que consta de uno o varios rangos, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial, este método devuelve undefined.
getSpillingToRange()	Obtiene el objeto de intervalo que contiene el intervalo de desbordamiento al llamar en una celda de delimitador. Si el rango no es una celda delimitadora o no se encuentra el intervalo de desbordamiento, este método devuelve undefined.
getSpillParent()	Obtiene el objeto de rango que contiene la celda delimitadora en la que se derrama la celda. Si no es una celda derramada o se proporciona más de una celda, este método devuelve undefined.
getSurroundingRegion()	Devuelve un Range objeto que representa la región circundante de la celda superior izquierda de este rango. Una región circundante es un intervalo limitado por cualquier combinación de filas y columnas en blanco en relación a este intervalo.
getTables(fullyContained)	Obtiene una colección con ámbito de tablas que se superpone con el intervalo.
getText()	Representa el valor text 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. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).
getTexts()	Valores de texto del intervalo especificado. El valor Text no dependerá del ancho de la celda. La sustitución del signo de número (#) que se produce en la interfaz de usuario de Excel no afectará al valor de texto devuelto por la API.
getTop()	Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde superior de la hoja de cálculo hasta el borde superior del rango.
getUsedRange(valuesOnly)	Devuelve el intervalo usado del objeto de rango especificado. Si no hay celdas usadas dentro del rango, este método devuelve undefined.
getValue()	Representa el valor sin procesar del intervalo especificado. Los datos devueltos pueden ser de tipo cadena, número o booleano. La celda que contenga un error devolverá la cadena de error. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).
getValues()	Representa los valores sin formato del rango especificado. Los datos devueltos podrían ser una cadena, un número o un valor booleano. Las celdas que contienen un error devolverán la cadena de error. Si el valor devuelto comienza con un signo más ("+"), menos ("-") o un signo igual ("="), Excel interpreta este valor como una fórmula.
getValueType()	Representa el tipo de datos de la celda. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).
getValueTypes()	Especifica el tipo de datos de cada celda.
getVisibleView()	Representa las filas visibles del intervalo actual.
getWidth()	Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde izquierdo del intervalo hasta el borde derecho del intervalo.
getWorksheet()	Hoja de cálculo que contiene el rango actual.
group(groupOption)	Grupos columnas y filas para un esquema.
hideGroupDetails(groupOption)	Oculta los detalles del grupo de filas o columnas.
insert(shift)	Inserta una celda o un intervalo de celdas en la hoja de cálculo en lugar de este intervalo y desplaza las demás celdas para crear espacio. Devuelve un nuevo Range objeto en el espacio ahora en blanco.
merge(across)	Combina las celdas del intervalo en una región de la hoja de cálculo.
moveTo(destinationRange)	Mueve los valores de celda, el formato y las fórmulas del rango actual al intervalo de destino, reemplazando la información antigua de esas celdas. El intervalo de destino se expandirá automáticamente si es menor que el intervalo actual. No se cambian las celdas del rango de destino que están fuera del área del rango original.
removeDuplicates(columns, includesHeader)	Quita los valores duplicados del intervalo especificado por las columnas.
replaceAll(text, replacement, criteria)	Busca y reemplaza la cadena especificada, según los criterios especificados dentro del intervalo actual.
select()	Selecciona el intervalo especificado en la interfaz de usuario de Excel.
setColumnHidden(columnHidden)	Representa si todas las columnas del intervalo actual están ocultas. El valor es true cuando todas las columnas de un intervalo están ocultas. El valor es false cuando no se oculta ninguna columna del intervalo. El valor es null cuando algunas columnas de un rango están ocultas y otras columnas del mismo rango no están ocultas.
setDirty()	Establece un intervalo que se deberá actualizar cuando se realice la próxima actualización.
setFormula(formula)	Establece la fórmula de celda en notación de estilo A1. Si el rango contiene varias celdas, cada celda del rango especificado se actualizará con los datos de entrada.
setFormulaLocal(formulaLocal)	Establezca la fórmula de celda en notación de estilo A1, en la configuración regional de formato de número y idioma del usuario. Por ejemplo, la fórmula "=SUM(A1, 1.5)" en inglés se convertiría en "=SUMME(A1; 1,5)" en alemán. Si el rango contiene varias celdas, cada celda del rango especificado se actualizará con los datos de entrada.
setFormulaR1C1(formulaR1C1)	Establece la fórmula de celda en notación de estilo R1C1. Si el rango contiene varias celdas, cada celda del rango especificado se actualizará con los datos de entrada.
setFormulas(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.
setFormulasLocal(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.
setFormulasR1C1(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.
setHyperlink(hyperlink)	Representa el hipervínculo del intervalo actual.
setNumberFormat(numberFormat)	Establece el código de formato de número de excel de celda para el intervalo especificado. Si el rango contiene varias celdas, cada celda del rango especificado se actualizará con los datos de entrada.
setNumberFormatLocal(numberFormatLocal)	Establece el código de formato de número de celda de Excel para el intervalo determinado, en función de la configuración de idioma del usuario. Excel no realiza ninguna coerción de idioma o formato al obtener o establecer la numberFormatLocal propiedad. Cualquier texto devuelto usa las cadenas con formato local en función del idioma especificado en la configuración del sistema. Si el rango contiene varias celdas, cada celda del rango especificado se actualizará con los datos de entrada.
setNumberFormats(numberFormats)	Representa el código de formato de número de Excel para el intervalo especificado.
setNumberFormatsLocal(numberFormatsLocal)	Representa el código de formato de número de Excel para el intervalo especificado, en función de la configuración de idioma del usuario. Excel no realiza ninguna coerción de idioma o formato al obtener o establecer la numberFormatLocal propiedad. Cualquier texto devuelto usa las cadenas con formato local en función del idioma especificado en la configuración del sistema.
setPredefinedCellStyle(predefinedCellStyle)	Representa el estilo del rango actual.
setRowHidden(rowHidden)	Representa si todas las filas del intervalo actual están ocultas. El valor es true cuando todas las filas de un intervalo están ocultas. El valor es false cuando no se oculta ninguna fila del intervalo. El valor es null cuando algunas filas de un rango están ocultas y otras filas del mismo rango no están ocultas.
setValue(value)	Establece el valor sin procesar del intervalo especificado. Los datos que se establecen pueden ser de tipo cadena, número o booleano. null se omitirá el valor (no se establece ni se sobrescribe en Excel). Si el rango contiene varias celdas, cada celda del rango especificado se actualizará con los datos de entrada.
setValues(values)	Establece los valores sin procesar del intervalo especificado. Los datos proporcionados pueden ser una cadena, un número o un valor booleano. Si el valor proporcionado comienza con un signo más ("+"), menos ("-") o un signo igual ("="), Excel interpreta este valor como una fórmula.
showCard()	Muestra la tarjeta de una celda activa si tiene contenido de valor enriquecido.
showGroupDetails(groupOption)	Muestra los detalles del grupo de filas o columnas.
ungroup(groupOption)	Desagrupa columnas y filas para un esquema.
unmerge()	Separa las celdas del intervalo en celdas independientes.

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

Ejemplos

/**
 * This sample applies conditional formatting to the currently used range in the worksheet. 
 * The conditional formatting is a green fill for the top 10% of values.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the used range in the worksheet.
  let range = selectedSheet.getUsedRange();

  // Set the fill color to green for the top 10% of values in the range.
  let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
  conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
  conditionalFormat.getTopBottom().setRule({
    rank: 10, // The percentage threshold.
    type: ExcelScript.ConditionalTopBottomCriterionType.topPercent // The type of the top/bottom condition.
  });
}

autoFill(destinationRange, autoFillType)

Rellena un intervalo desde el intervalo actual hasta el intervalo de destino mediante la lógica de autorrellenar especificada. El intervalo de destino puede ser null o puede extender el intervalo de origen horizontal o verticalmente. No se admiten intervalos de discontiguous.

autoFill(
            destinationRange?: Range | string,
            autoFillType?: AutoFillType
        ): void;

Parámetros

destinationRange

ExcelScript.Range | string

Intervalo de destino que se va a Autorrellenar. Si el intervalo de destino es null, los datos se rellenan en función de las celdas circundantes (que es el comportamiento al hacer doble clic en el identificador de relleno de rango de la interfaz de usuario).

autoFillType

ExcelScript.AutoFillType

Tipo de Autorrellenar. Especifica cómo se va a rellenar el intervalo de destino, en función del contenido del intervalo actual. El valor predeterminado es "FillDefault".

Devoluciones

void

Ejemplos

/**
 * This script uses the autofill feature to complete a table.
 * See https://support.microsoft.com/office/74e31bdd-d993-45da-aa82-35a236c5b5db
 * for examples of autofill scenarios.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let currentWorksheet = workbook.getActiveWorksheet();

  // Get the data range that shows the pattern.
  let dataRange = currentWorksheet.getRange("C2:C3");

  // Autofill the connected range. C2:C3 are filled in. C4:C14 are blank.
  // This uses the default behavior to match a pattern with the table's contents.
  dataRange.autoFill("C2:C14");
}

calculate()

Calcula un rango de celdas en una hoja de cálculo.

calculate(): void;

Devoluciones

void

Ejemplos

/**
 * This script recalculates the used range of a specific worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Only recalculate if the calculation mode is not set to automatic.
  if (workbook.getApplication().getCalculationMode() !== ExcelScript.CalculationMode.automatic) {
    // Get the used range from a worksheet named "Monthly Report".
    const sheet = workbook.getWorksheet("Monthly Report");
    const range = sheet.getUsedRange();
    console.log(`Calculating ${range.getAddress()}`);

    // Force all the used cells in that worksheet to calculate.
    sheet.getUsedRange().calculate();
  }
}

clear(applyTo)

Borra valores de rango, formato, relleno, borde, etc.

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.

Devoluciones

void

Ejemplos

/**
 * This script removes all the formatting from the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  let range = workbook.getSelectedRange();

  // Clear all the formatting in that range.
  range.clear(ExcelScript.ClearApplyTo.formats);
}

clearAllConditionalFormats()

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

clearAllConditionalFormats(): void;

Devoluciones

void

convertDataTypeToText()

Convierte las celdas de rango 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 intervalo actual. El intervalo de destino puede tener un tamaño diferente al intervalo de origen o RangeAreas. El destino se expande automáticamente si es menor que el origen. Nota: Al igual que la funcionalidad de copia en la interfaz de usuario de Excel, si el intervalo de destino es un múltiplo exacto mayor que el intervalo de origen en filas o columnas, el contenido de origen se replica varias veces. Por ejemplo, una copia de intervalo 2x2 en un intervalo de 2x6 dará como resultado 3 copias del intervalo 2x2 original.

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 intervalo de origen. El valor predeterminado es false.

transpose

boolean

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

Devoluciones

void

Ejemplos

/**
 * This script copies a table from one worksheet to a new worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the worksheet named "TableTemplate".
  let base = workbook.getWorksheet("TableTemplate");
  
  // Get the range to be copied based on the first table.
  let tableRange = base.getTables()[0].getRange();

  // Get the area in a new worksheet for the new table.
  let newWorksheet = workbook.addWorksheet();
  let newRange = newWorksheet.getRangeByIndexes(0,0, tableRange.getRowCount(), tableRange.getColumnCount());

  // Copy the existing data into the new range.
  newRange.copyFrom(tableRange);
}

delete(shift)

Elimina las celdas asociadas al rango.

delete(shift: DeleteShiftDirection): void;

Parámetros

shift

ExcelScript.DeleteShiftDirection

Especifica hacia dónde se desplazarán las celdas. Vea ExcelScript.DeleteShiftDirection para más información.

Devoluciones

void

Ejemplos

/**
 * This sample creates a sample range, then deletes
 * "A1" using different DeleteShiftDirection values.
 */
function main(workbook: ExcelScript.Workbook) {
  // Add sample data to better visualize the delete changes.
  const currentSheet = workbook.getActiveWorksheet();
  currentSheet.getRange("A1:D4").setValues([
    [1,2,3,4],
    [5,6,7,8],
    [9,10,11,12],
    [13,14,15,16]]);

  // Delete A1 and shift the cells from the right to fill the space.
  // The value being deleted is 1.
  currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.left);

  // Delete A1 and shift the cells from the bottom to fill the space.
  // The value being deleted is 2.
  currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.up);

  // Log the sample range. The values should be:
  /*
    5, 3, 4, "",
    9, 6, 7, 8,
    13, 10, 11, 12,
    "", 14, 15, 16
  */
  console.log(currentSheet.getRange("A1:D4").getValues()); 
}

find(text, criteria)

Busca la cadena especificada, según los criterios especificados. Si el rango actual es mayor que una sola celda, la búsqueda se limitará a ese rango; de lo contrario, la búsqueda cubrirá toda la hoja a partir de esa celda. Si no hay ninguna coincidencia, este método devuelve undefined.

find(text: string, criteria: SearchCriteria): Range;

Parámetros

text

string

Cadena que se va a buscar.

criteria

ExcelScript.SearchCriteria

Criterios de búsqueda adicionales, incluida la dirección de búsqueda y si la búsqueda debe coincidir con toda la celda o distinguir entre mayúsculas y minúsculas.

Devoluciones

ExcelScript.Range

Ejemplos

/**
 * This script searches through a table column and finds cells marked "no change". 
 * Those cells have "no change" replaced with the value from the cell to the left.
 * This script uses Range.find instead of Worksheet.findAll 
 * to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range of a table named "Orders".
  let table = workbook.getTable("Orders");
  let range = table.getColumnByName("March").getRange();

  // Find all cells with the value "no change".
  let cellToOverwrite = range.find("no change", { completeMatch: true });
  while (cellToOverwrite) {
    let cellToCopyFrom = cellToOverwrite.getOffsetRange(0,-1);
    cellToOverwrite.setValue(cellToCopyFrom.getValue());
    cellToOverwrite = range.find("no change", { completeMatch: true });
  }
}

flashFill()

Realiza un relleno flash en el intervalo actual. El relleno flash rellena automáticamente los datos cuando detecta un patrón, por lo que el intervalo debe ser un único rango de columnas y tener datos alrededor de él para encontrar un patrón.

flashFill(): void;

Devoluciones

void

Ejemplos

/**
 * This script uses the Flash Fill feature to complete a table.
 * See https://support.microsoft.com/office/3f9bcf1e-db93-4890-94a0-1578341f73f7
 * for the example table.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let currentWorksheet = workbook.getActiveWorksheet();

  // Get the data range with a pattern and cells to fill. C2 is filled in. C3:C6 are blank.
  let dataRange = currentWorksheet.getRange("C2:C6");

  // Flash fill the connected range. 
  dataRange.flashFill();
}

getAbsoluteResizedRange(numRows, numColumns)

Obtiene un Range objeto con la misma celda superior izquierda que el objeto actual Range , pero con los números especificados de filas y columnas.

getAbsoluteResizedRange(numRows: number, numColumns: number): Range;

Parámetros

numRows

number

Número de filas del nuevo tamaño de intervalo.

numColumns

number

Número de columnas del nuevo tamaño de intervalo.

Devoluciones

ExcelScript.Range

getAddress()

Especifica la referencia de rango en estilo A1. El valor de dirección contiene la referencia de hoja (por ejemplo, "Sheet1! A1:B4").

getAddress(): string;

Devoluciones

string

Ejemplos

/**
 * This script logs the address of the used range in each worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Iterate over every worksheet in the workbook.
  workbook.getWorksheets().forEach((sheet) => {
    // Get the used range for a single worksheet.
    let range = sheet.getUsedRange();

    // Print the address of the used range to the console.
    console.log(range.getAddress());
  });
}

getAddressLocal()

Representa la referencia de intervalo para el intervalo especificado en el idioma del usuario.

getAddressLocal(): string;

Devoluciones

string

getBoundingRect(anotherRange)

Obtiene el objeto de intervalo más pequeño que abarca los intervalos especificados. Por ejemplo, el GetBoundingRect de "B2:C5" y "D10:E15" es "B2:E15".

getBoundingRect(anotherRange: Range | string): Range;

Parámetros

anotherRange

ExcelScript.Range | string

El objeto de rango, la dirección o el nombre del rango.

Devoluciones

ExcelScript.Range

Ejemplos

/**
 * This script gets the bounding range of two existing ranges and puts a border around it.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let sheet = workbook.getActiveWorksheet();

  // Create two range objects for the sample.
  let range1 = sheet.getRange("B2:C5");
  let range2 = sheet.getRange("D10:E15");

  // Get the rectangular range that fully includes both ranges.
  let boundingRectangle = range1.getBoundingRect(range2);

  // Add a border around the whole bounding range (B2:E15).
  let format = boundingRectangle.getFormat();
  format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
}

getCell(row, column)

Obtiene el objeto de intervalo que contiene la celda en función de los números de fila y columna. La celda puede estar fuera de los límites de su rango primario, siempre y cuando permanezca dentro de la cuadrícula de la hoja de cálculo. La celda devuelta se ubica con respecto a la celda superior izquierda del intervalo.

getCell(row: number, column: number): Range;

Parámetros

row

number

Número de fila de la celda que se va a recuperar. Indizado con cero.

column

number

Número de columna de la celda que se va a recuperar. Indizado con cero.

Devoluciones

ExcelScript.Range

getCellCount()

Especifica el número de celdas del rango. Esta API devolverá -1 si el recuento de celdas supera 2^31-1 (2 147 483 647).

getCellCount(): number;

Devoluciones

number

getColumn(column)

Obtiene una columna contenida en el intervalo.

getColumn(column: number): Range;

Parámetros

column

number

Número de columna del intervalo que se va a recuperar. Indizado con cero.

Devoluciones

ExcelScript.Range

getColumnCount()

Especifica el número total de columnas del intervalo.

getColumnCount(): number;

Devoluciones

number

Ejemplos

/**
 * This sample provides the count of negative numbers that are present
 * in the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the working range.
  let usedRange = workbook.getActiveWorksheet().getUsedRange();
  let rowCount = usedRange.getRowCount();
  let columnCount = usedRange.getColumnCount();

  // Save the values locally to avoid repeatedly asking the workbook.
  let usedRangeValues = usedRange.getValues();

  // Start the negative number counter.
  let negativeCount = 0;

  // Iterate over the entire range looking for negative numbers.
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < columnCount; j++) {
      if (usedRangeValues[i][j] < 0) {
        negativeCount++;
      }
    }
  }

  // Log the negative number count to the console.
  console.log(negativeCount);
}

getColumnHidden()

Representa si todas las columnas del intervalo actual están ocultas. El valor es true cuando todas las columnas de un intervalo están ocultas. El valor es false cuando no se oculta ninguna columna del intervalo. El valor es null cuando algunas columnas de un rango están ocultas y otras columnas del mismo rango no están ocultas.

getColumnHidden(): boolean;

Devoluciones

boolean

getColumnIndex()

Especifica el número de columna de la primera celda del intervalo. Indizado con cero.

getColumnIndex(): number;

Devoluciones

number

getColumnsAfter(count)

Obtiene un determinado número de columnas a la derecha del objeto actual Range .

getColumnsAfter(count?: number): Range;

Parámetros

count

number

Opcional. El número de columnas que se va a incluir en el rango resultante. En general, use un número positivo para crear un intervalo fuera del intervalo actual. También puede usar un número negativo para crear un intervalo dentro del intervalo actual. El valor predeterminado es 1.

Devoluciones

ExcelScript.Range

getColumnsBefore(count)

Obtiene un determinado número de columnas a la izquierda del objeto actual Range .

getColumnsBefore(count?: number): Range;

Parámetros

count

number

Opcional. El número de columnas que se va a incluir en el rango resultante. En general, use un número positivo para crear un intervalo fuera del intervalo actual. También puede usar un número negativo para crear un intervalo dentro del intervalo actual. El valor predeterminado es 1.

Devoluciones

ExcelScript.Range

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

La colección de ConditionalFormats que interseca el intervalo.

getConditionalFormats(): ConditionalFormat[];

Devoluciones

ExcelScript.ConditionalFormat[]

getDataValidation()

Devuelve un objeto de validación de datos.

getDataValidation(): DataValidation;

Devoluciones

ExcelScript.DataValidation

Ejemplos

/**
 * This script creates a drop-down selection list for a cell. It uses the existing values of the selected range as the choices for the list.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the values for data validation.
  let selectedRange = workbook.getSelectedRange();
  let rangeValues = selectedRange.getValues();

  // Convert the values into a comma-delimited string.
  let dataValidationListString = "";
  rangeValues.forEach((rangeValueRow) => {
    rangeValueRow.forEach((value) => {
      dataValidationListString += value + ",";
    });
  });

  // Clear the old range.
  selectedRange.clear(ExcelScript.ClearApplyTo.contents);

  // Apply the data validation to the first cell in the selected range.
  let targetCell = selectedRange.getCell(0,0);
  let dataValidation = targetCell.getDataValidation();

  // Set the content of the drop-down list.
  dataValidation.setRule({
      list: {
        inCellDropDown: true,
        source: dataValidationListString
      }
    });
}

getDirectPrecedents()

Devuelve un WorkbookRangeAreas objeto que representa el rango que contiene todas las celdas precedentes directas de un rango especificado en la misma hoja de cálculo o en varias hojas de cálculo.

getDirectPrecedents(): WorkbookRangeAreas;

Devoluciones

ExcelScript.WorkbookRangeAreas

Ejemplos

/**
 * This script finds the direct precedents of the active cell.
 * It changes the font and color of those precedent cells. 
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  const selected = workbook.getActiveCell();
  
  // Get the cells that are direct precedents of the current cell.
  const precedents : ExcelScript.WorkbookRangeAreas = selected.getDirectPrecedents();

  // Set the font to bold and the fill color to orange for all the precedent cells.
  precedents.getRanges().forEach(range => {
    range.getFormat().getFill().setColor("orange");
    range.getFormat().getFont().setBold(true);
  });
}

getEntireColumn()

Obtiene un objeto que representa toda la columna del rango (por ejemplo, si el rango actual representa las celdas "B4:E11", es getEntireColumn un rango que representa las columnas "B:E").

getEntireColumn(): Range;

Devoluciones

ExcelScript.Range

getEntireRow()

Obtiene un objeto que representa toda la fila del rango (por ejemplo, si el rango actual representa las celdas "B4:E11", es GetEntireRow un rango que representa las filas "4:11").

getEntireRow(): Range;

Devoluciones

ExcelScript.Range

getExtendedRange(direction, activeCell)

Devuelve un objeto de rango que incluye el intervalo actual y hasta el borde del intervalo, en función de la dirección proporcionada. Esto coincide con el comportamiento de la tecla Ctrl+Mayús+Flecha en la interfaz de usuario de Excel en Windows.

getExtendedRange(
            direction: KeyboardDirection,
            activeCell?: Range | string
        ): Range;

Parámetros

direction

ExcelScript.KeyboardDirection

Dirección de la celda activa.

activeCell

ExcelScript.Range | string

Celda activa de este rango. De forma predeterminada, la celda activa es la celda superior izquierda del rango. Se produce un error si la celda activa no está en este intervalo.

Devoluciones

ExcelScript.Range

Ejemplos

/**
 * This script makes the font bold on all the contiguous cells between 
 * A1 and the bottom of the used range of the first column.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get every cell that's used between A1 and the end of the column.
  // This recreates the Ctrl+Shift+Down arrow key behavior.
  let firstCell = selectedSheet.getRange("A1");
  let firstColumn = firstCell.getExtendedRange(ExcelScript.KeyboardDirection.down);

  // Set the font to bold in that range.
  firstColumn.getFormat().getFont().setBold(true);
}

getFormat()

Devuelve un objeto de formato que encapsula la fuente, el relleno, los bordes, la alineación y otras propiedades del rango.

getFormat(): RangeFormat;

Devoluciones

ExcelScript.RangeFormat

Ejemplos

/**
 * This script gives the total row of a table a green color fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  let table = workbook.getTables()[0];

  // Get the range for the total row of the table.
  let totalRange = table.getTotalRowRange();

  // Set the fill color to green.
  totalRange.getFormat().getFill().setColor("green");
}

getFormula()

Representa la fórmula de celda en notación de estilo A1. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).

getFormula(): string;

Devoluciones

string

Ejemplos

/*
 * This script sets a cell's formula, 
 * then displays how Excel stores the cell's formula and value separately.
 */
function main(workbook: ExcelScript.Workbook) {
  let selectedSheet = workbook.getActiveWorksheet();

  // Set A1 to 2.
  let a1 = selectedSheet.getRange("A1");
  a1.setValue(2);

  // Set B1 to the formula =(2*A1), which should equal 4.
  let b1 = selectedSheet.getRange("B1")
  b1.setFormula("=(2*A1)");

  // Log the current results for `getFormula` and `getValue` at B1.
  console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
}

getFormulaLocal()

Representa la fórmula de celda en notación de estilo A1, en la configuración regional de formato de número y idioma del usuario. Por ejemplo, la fórmula "=SUM(A1, 1.5)" en inglés se convertiría en "=SUMME(A1; 1,5)" en alemán. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).

getFormulaLocal(): string;

Devoluciones

string

getFormulaR1C1()

Representa la fórmula de celda en la notación de estilo R1C1. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).

getFormulaR1C1(): string;

Devoluciones

string

getFormulas()

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.

getFormulas(): string[][];

Devoluciones

string[][]

getFormulasLocal()

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.

getFormulasLocal(): string[][];

Devoluciones

string[][]

getFormulasR1C1()

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.

getFormulasR1C1(): string[][];

Devoluciones

string[][]

getHasSpill()

Indica si todas las celdas tienen un borde de desbordamiento. Devuelve true si todas las celdas tienen un borde de derrame o false si todas las celdas no tienen un borde de desbordamiento. Devuelve null si hay celdas con y sin bordes de desbordamiento dentro del intervalo.

getHasSpill(): boolean;

Devoluciones

boolean

getHeight()

Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde superior del rango hasta el borde inferior del intervalo.

getHeight(): number;

Devoluciones

number

getHidden()

Representa si todas las celdas del rango actual están ocultas. El valor es true cuando todas las celdas de un rango están ocultas. El valor es false cuando no se oculta ninguna celda del rango. El valor es null cuando algunas celdas de un rango están ocultas y otras celdas del mismo rango no están ocultas.

getHidden(): boolean;

Devoluciones

boolean

getHyperlink()

Representa el hipervínculo del intervalo actual.

getHyperlink(): RangeHyperlink;

Devoluciones

ExcelScript.RangeHyperlink

Ejemplos

/**
 * This sample clears all of the hyperlinks from the current worksheet
 * and removes the usual hyperlink formatting.
 */
function main(workbook: ExcelScript.Workbook, sheetName: string = 'Sheet1') {
  // Get the active worksheet. 
  let sheet = workbook.getWorksheet(sheetName);

  // Get the used range to operate on.
  // For large ranges (over 10000 entries), consider splitting the operation into batches for performance.
  const targetRange = sheet.getUsedRange(true);
  console.log(`Target Range to clear hyperlinks from: ${targetRange.getAddress()}`);

  const rowCount = targetRange.getRowCount();
  const colCount = targetRange.getColumnCount();
  console.log(`Searching for hyperlinks in ${targetRange.getAddress()} which contains ${(rowCount * colCount)} cells`);

  // Go through each individual cell looking for a hyperlink. 
  // This allows us to limit the formatting changes to only the cells with hyperlink formatting.
  let clearedCount = 0;
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < colCount; j++) {
      const cell = targetRange.getCell(i, j);
      const hyperlink = cell.getHyperlink();
      if (hyperlink) {
        cell.clear(ExcelScript.ClearApplyTo.hyperlinks);
        cell.getFormat().getFont().setUnderline(ExcelScript.RangeUnderlineStyle.none);
        cell.getFormat().getFont().setColor('Black');
        clearedCount++;
      }
    }
  }

  console.log(`Done. Cleared hyperlinks from ${clearedCount} cells`);
}

getImage()

Representa el intervalo como una imagen png codificada en base64.

getImage(): string;

Devoluciones

string

getIntersection(anotherRange)

Obtiene el objeto de rango que representa la intersección rectangular de los rangos especificados. Si no se encuentra ninguna intersección, este método devuelve undefined.

getIntersection(anotherRange: Range | string): Range;

Parámetros

anotherRange

ExcelScript.Range | string

Objeto de intervalo o dirección de intervalo que se usará para determinar la intersección de los intervalos.

Devoluciones

ExcelScript.Range

getIsEntireColumn()

Representa si el intervalo actual es una columna completa.

getIsEntireColumn(): boolean;

Devoluciones

boolean

getIsEntireRow()

Representa si el intervalo actual es una fila completa.

getIsEntireRow(): boolean;

Devoluciones

boolean

getLastCell()

Obtiene la última celda del intervalo. Por ejemplo, la última celda de "B2:D5" es "D5".

getLastCell(): Range;

Devoluciones

ExcelScript.Range

getLastColumn()

Obtiene la última columna del intervalo. Por ejemplo, la última columna de "B2:D5" es "D2:D5".

getLastColumn(): Range;

Devoluciones

ExcelScript.Range

getLastRow()

Obtiene la última fila del intervalo. Por ejemplo, la última fila de "B2:D5" es "B5:D5".

getLastRow(): Range;

Devoluciones

ExcelScript.Range

getLeft()

Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde izquierdo de la hoja de cálculo hasta el borde izquierdo del rango.

getLeft(): number;

Devoluciones

number

getLinkedDataTypeState()

Representa el estado del tipo de datos de la celda.

getLinkedDataTypeState(): LinkedDataTypeState;

Devoluciones

ExcelScript.LinkedDataTypeState

getLinkedDataTypeStates()

Indica el estado del tipo de datos de cada celda.

getLinkedDataTypeStates(): LinkedDataTypeState[][];

Devoluciones

ExcelScript.LinkedDataTypeState[][]

getMergedAreas()

Devuelve un RangeAreas objeto que representa las áreas combinadas de este intervalo. Tenga en cuenta que si el recuento de áreas combinadas en este intervalo es superior a 512, este método no devolverá el resultado. Si el RangeAreas objeto no existe, esta función devuelve undefined.

getMergedAreas(): RangeAreas;

Devoluciones

ExcelScript.RangeAreas

getNumberFormat()

Representa el código de formato de número de celda de Excel para el intervalo especificado. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).

getNumberFormat(): string;

Devoluciones

string

getNumberFormatCategories()

Representa la categoría de formato numérico de cada celda.

getNumberFormatCategories(): NumberFormatCategory[][];

Devoluciones

ExcelScript.NumberFormatCategory[][]

Ejemplos

/**
 * This script finds cells in a table column that are not formatted as currency
 * and sets the fill color to red.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the "Cost" column from the "Expenses" table.
  const table = workbook.getTable("Expenses");
  const costColumn = table.getColumnByName("Cost");
  const costColumnRange = costColumn.getRangeBetweenHeaderAndTotal();

  // Get the number format categories for the column's range.
  const numberFormatCategories = costColumnRange.getNumberFormatCategories();

  // If any cell in the column doesn't have a currency format, make the cell red.
  numberFormatCategories.forEach((category, index) =>{
    if (category[0] != ExcelScript.NumberFormatCategory.currency) {
      costColumnRange.getCell(index, 0).getFormat().getFill().setColor("red");
    }
  }); 
}

getNumberFormatCategory()

Especifica la categoría de formato de número de la primera celda del rango (representada por el índice de fila de 0 y el índice de columna de 0).

getNumberFormatCategory(): NumberFormatCategory;

Devoluciones

ExcelScript.NumberFormatCategory

getNumberFormatLocal()

Representa el código de formato de número de celda de Excel para el intervalo especificado, en función de la configuración de idioma del usuario. Excel no realiza ninguna coerción de idioma o formato al obtener o establecer la numberFormatLocal propiedad. Cualquier texto devuelto usa las cadenas con formato local en función del idioma especificado en la configuración del sistema. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).

getNumberFormatLocal(): string;

Devoluciones

string

getNumberFormats()

Representa el código de formato de número de Excel para el intervalo especificado.

getNumberFormats(): string[][];

Devoluciones

string[][]

getNumberFormatsLocal()

Representa el código de formato de número de Excel para el intervalo especificado, en función de la configuración de idioma del usuario. Excel no realiza ninguna coerción de idioma o formato al obtener o establecer la numberFormatLocal propiedad. Cualquier texto devuelto usa las cadenas con formato local en función del idioma especificado en la configuración del sistema.

getNumberFormatsLocal(): string[][];

Devoluciones

string[][]

getOffsetRange(rowOffset, columnOffset)

Obtiene un objeto que representa un intervalo desplazado con respecto al intervalo especificado. La dimensión del rango devuelto coincidirá con este rango. Si el rango resultante se fuerza más allá de los límites de la cuadrícula de la hoja de cálculo, se producirá un error.

getOffsetRange(rowOffset: number, columnOffset: number): Range;

Parámetros

rowOffset

number

Número de filas (número positivo, negativo o 0) que debe desplazarse el intervalo. Los valores positivos desplazan hacia abajo, mientras que los negativos lo hacen hacia arriba.

columnOffset

number

Número de columnas (número positivo, negativo o 0) que debe desplazarse el intervalo. Los valores positivos desplazan hacia la derecha, mientras que los negativos lo hacen hacia la izquierda.

Devoluciones

ExcelScript.Range

Ejemplos

/**
 * This script gets adjacent cells using relative references.
 * Note that if the active cell is on the top row, part of the script fails, 
 * because it references the cell above the currently selected one.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the currently active cell in the workbook.
  let activeCell = workbook.getActiveCell();
  console.log(`The active cell's address is: ${activeCell.getAddress()}`);

  // Get the cell to the right of the active cell and set its value and color.
  let rightCell = activeCell.getOffsetRange(0,1);
  rightCell.setValue("Right cell");
  console.log(`The right cell's address is: ${rightCell.getAddress()}`);
  rightCell.getFormat().getFont().setColor("Magenta");
  rightCell.getFormat().getFill().setColor("Cyan");

  // Get the cell to the above of the active cell and set its value and color.
  // Note that this operation will fail if the active cell is in the top row.
  let aboveCell = activeCell.getOffsetRange(-1, 0);
  aboveCell.setValue("Above cell");
  console.log(`The above cell's address is: ${aboveCell.getAddress()}`);
  aboveCell.getFormat().getFont().setColor("White");
  aboveCell.getFormat().getFill().setColor("Black");
}

getPivotTables(fullyContained)

Obtiene una colección con ámbito de tablas dinámicas que se superponen con el intervalo.

getPivotTables(fullyContained?: boolean): PivotTable[];

Parámetros

fullyContained

boolean

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

Devoluciones

ExcelScript.PivotTable[]

getPredefinedCellStyle()

Representa el estilo del rango actual. 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

getRangeEdge(direction, activeCell)

Devuelve un objeto de rango que es la celda perimetral de la región de datos que corresponde a la dirección proporcionada. Esto coincide con el comportamiento de la tecla Ctrl+Flecha en la interfaz de usuario de Excel en Windows.

getRangeEdge(
            direction: KeyboardDirection,
            activeCell?: Range | string
        ): Range;

Parámetros

direction

ExcelScript.KeyboardDirection

Dirección de la celda activa.

activeCell

ExcelScript.Range | string

Celda activa de este rango. De forma predeterminada, la celda activa es la celda superior izquierda del rango. Se produce un error si la celda activa no está en este intervalo.

Devoluciones

ExcelScript.Range

Ejemplos

/**
 * This script adds the value "Total" after the end of the first column.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the last used cell at the end of the column.
  // This recreates the Ctrl+Down arrow key behavior.
  let firstCell = selectedSheet.getRange("A1");
  let firstColumn = selectedSheet.getRange("A1").getRangeEdge(ExcelScript.KeyboardDirection.down);
  let cellAfter = firstColumn.getOffsetRange(1, 0);

  // Set the value of the cell after the current end of the used column to "Total".
  cellAfter.setValue("Total");
}

getResizedRange(deltaRows, deltaColumns)

Obtiene un Range objeto similar al objeto actual Range , pero con su esquina inferior derecha expandida (o contratada) por algún número de filas y columnas.

getResizedRange(deltaRows: number, deltaColumns: number): Range;

Parámetros

deltaRows

number

El número de filas en el que se va a expandir la esquina inferior derecha, con respecto al intervalo actual. Use un número positivo para expandir el intervalo, o un número negativo para reducirlo.

deltaColumns

number

Número de columnas por las que se va a expandir la esquina inferior derecha, en relación con el intervalo actual. Use un número positivo para expandir el intervalo, o un número negativo para reducirlo.

Devoluciones

ExcelScript.Range

Ejemplos

/**
 * This script copies the formatting in the active cell to the neighboring cells.
 * Note that this script only works when the active cell isn't on an edge of the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  let activeCell = workbook.getActiveCell();

  // Get the cell that's one row above and one column to the left of the active cell.
  let cornerCell = activeCell.getOffsetRange(-1,-1);

  // Get a range that includes all the cells surrounding the active cell.
  let surroundingRange = cornerCell.getResizedRange(2, 2)

  // Copy the formatting from the active cell to the new range.
  surroundingRange.copyFrom(
    activeCell, /* The source range. */
    ExcelScript.RangeCopyType.formats /* What to copy. */
  );
}

getRow(row)

Obtiene una fila contenida en el intervalo.

getRow(row: number): Range;

Parámetros

row

number

Número de fila del intervalo que se va a recuperar. Indizado con cero.

Devoluciones

ExcelScript.Range

getRowCount()

Devuelve el número total de filas del intervalo.

getRowCount(): number;

Devoluciones

number

Ejemplos

/**
 * This sample provides the count of negative numbers that are present
 * in the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the working range.
  let usedRange = workbook.getActiveWorksheet().getUsedRange();
  let rowCount = usedRange.getRowCount();
  let columnCount = usedRange.getColumnCount();

  // Save the values locally to avoid repeatedly asking the workbook.
  let usedRangeValues = usedRange.getValues();

  // Start the negative number counter.
  let negativeCount = 0;

  // Iterate over the entire range looking for negative numbers.
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < columnCount; j++) {
      if (usedRangeValues[i][j] < 0) {
        negativeCount++;
      }
    }
  }

  // Log the negative number count to the console.
  console.log(negativeCount);
}

getRowHidden()

Representa si todas las filas del intervalo actual están ocultas. El valor es true cuando todas las filas de un intervalo están ocultas. El valor es false cuando no se oculta ninguna fila del intervalo. El valor es null cuando algunas filas de un rango están ocultas y otras filas del mismo rango no están ocultas.

getRowHidden(): boolean;

Devoluciones

boolean

getRowIndex()

Devuelve el número de fila de la primera celda del intervalo. Indizado con cero.

getRowIndex(): number;

Devoluciones

number

getRowsAbove(count)

Obtiene un número determinado de filas por encima del objeto actual Range .

getRowsAbove(count?: number): Range;

Parámetros

count

number

Opcional. El número de filas que se va a incluir en el intervalo resultante. En general, use un número positivo para crear un intervalo fuera del intervalo actual. También puede usar un número negativo para crear un intervalo dentro del intervalo actual. El valor predeterminado es 1.

Devoluciones

ExcelScript.Range

getRowsBelow(count)

Obtiene un número determinado de filas por debajo del objeto actual Range .

getRowsBelow(count?: number): Range;

Parámetros

count

number

Opcional. El número de filas que se va a incluir en el intervalo resultante. En general, use un número positivo para crear un intervalo fuera del intervalo actual. También puede usar un número negativo para crear un intervalo dentro del intervalo actual. El valor predeterminado es 1.

Devoluciones

ExcelScript.Range

getSavedAsArray()

Representa si todas las celdas se guardarían como una fórmula de matriz. Devuelve true si todas las celdas se guardarían como una fórmula de matriz o false si todas las celdas no se guardarían como una fórmula de matriz. Devuelve null si algunas celdas se guardarían como una fórmula de matriz y otras no lo serían.

getSavedAsArray(): boolean;

Devoluciones

boolean

getSort()

Representa la ordenación del intervalo del intervalo actual.

getSort(): RangeSort;

Devoluciones

ExcelScript.RangeSort

getSpecialCells(cellType, cellValueType)

Obtiene el RangeAreas objeto, que consta de uno o varios rangos, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial, 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

Ejemplos

/**
 * This sample gets all the blank cells in the current worksheet's used range. It then highlights all those cells with a yellow background.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the current used range.
    let range = workbook.getActiveWorksheet().getUsedRange();
    
    // Get all the blank cells.
    let blankCells = range.getSpecialCells(ExcelScript.SpecialCellType.blanks);
    // Highlight the blank cells with a yellow background.
    blankCells.getFormat().getFill().setColor("yellow");
}

getSpillingToRange()

Obtiene el objeto de intervalo que contiene el intervalo de desbordamiento al llamar en una celda de delimitador. Si el rango no es una celda delimitadora o no se encuentra el intervalo de desbordamiento, este método devuelve undefined.

getSpillingToRange(): Range;

Devoluciones

ExcelScript.Range

getSpillParent()

Obtiene el objeto de rango que contiene la celda delimitadora en la que se derrama la celda. Si no es una celda derramada o se proporciona más de una celda, este método devuelve undefined.

getSpillParent(): Range;

Devoluciones

ExcelScript.Range

getSurroundingRegion()

Devuelve un Range objeto que representa la región circundante de la celda superior izquierda de este rango. Una región circundante es un intervalo limitado por cualquier combinación de filas y columnas en blanco en relación a este intervalo.

getSurroundingRegion(): Range;

Devoluciones

ExcelScript.Range

getTables(fullyContained)

Obtiene una colección con ámbito de tablas que se superpone con el intervalo.

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[]

getText()

Representa el valor text 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. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).

getText(): string;

Devoluciones

string

getTexts()

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

getTexts(): string[][];

Devoluciones

string[][]

getTop()

Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde superior de la hoja de cálculo hasta el borde superior del rango.

getTop(): number;

Devoluciones

number

getUsedRange(valuesOnly)

Devuelve el intervalo usado del objeto de rango especificado. Si no hay celdas usadas dentro del rango, este método devuelve undefined.

getUsedRange(valuesOnly?: boolean): Range;

Parámetros

valuesOnly

boolean

Solo tiene en cuenta las celdas con valores como celdas usadas.

Devoluciones

ExcelScript.Range

getValue()

Representa el valor sin procesar del intervalo especificado. Los datos devueltos pueden ser de tipo cadena, número o booleano. La celda que contenga un error devolverá la cadena de error. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).

getValue(): string | number | boolean;

Devoluciones

string | number | boolean

Ejemplos

/**
 * This sample reads the value of A1 and prints it to the console.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the value of cell A1.
  let range = selectedSheet.getRange("A1");
  
  // Print the value of A1.
  console.log(range.getValue());
}

getValues()

Representa los valores sin formato del rango especificado. Los datos devueltos podrían ser una cadena, un número o un valor booleano. Las celdas que contienen un error devolverán la cadena de error. Si el valor devuelto comienza con un signo más ("+"), menos ("-") o un signo igual ("="), Excel interpreta este valor como una fórmula.

getValues(): (string | number | boolean)[][];

Devoluciones

(string | number | boolean)[][]

getValueType()

Representa el tipo de datos de la celda. Si el rango contiene varias celdas, se devolverán los datos de la primera celda (representados por el índice de fila de 0 y el índice de columna de 0).

getValueType(): RangeValueType;

Devoluciones

ExcelScript.RangeValueType

Ejemplos

/**
 * This script formats rows in a worksheet based on the first value in that row. 
 * If it's the boolean value TRUE, the row is bolded. 
 * If it's FALSE, nothing is changed. 
 * If the value type isn't a boolean, the row is italicized.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range in the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const usedRange = sheet.getUsedRange();

  // Get the values in the first column.
  const firstColumnValues = usedRange.getColumn(0).getValues();

  // Look at the first cell in each row.
  const rowCount = usedRange.getRowCount();
  for (let i = 0; i < rowCount; i++) {
    // Get the type of the first cell to make sure it's a boolean.
    let firstValueType = usedRange.getCell(i, 0).getValueType();

    // Set the bold or italic of the row as described earlier.
    if (firstValueType === ExcelScript.RangeValueType.boolean) {
      if (firstColumnValues[i][0] as boolean === true) {
        usedRange.getRow(i).getFormat().getFont().setBold(true);
      } else {
        usedRange.getRow(i).getFormat().getFont().setBold(false);
      }
    } else {
      usedRange.getRow(i).getFormat().getFont().setItalic(true);
    }
  }
}

getValueTypes()

Especifica el tipo de datos de cada celda.

getValueTypes(): RangeValueType[][];

Devoluciones

ExcelScript.RangeValueType[][]

getVisibleView()

Representa las filas visibles del intervalo actual.

getVisibleView(): RangeView;

Devoluciones

ExcelScript.RangeView

Ejemplos

/**
 * This script copies values and formatting from the 
 * visible range of a table in Sheet1 into Sheet2.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the filtered data from Sheet1.
  const currentSheet = workbook.getWorksheet("Sheet1");
  const table = currentSheet.getTables()[0];
  const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
  const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());

  // Copy the data into the other sheet.
  const otherSheet = workbook.getWorksheet("Sheet2");
  const otherRangeCorner = otherSheet.getRange("A1");
  otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
}

getWidth()

Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde izquierdo del intervalo hasta el borde derecho del intervalo.

getWidth(): number;

Devoluciones

number

getWorksheet()

Hoja de cálculo que contiene el rango actual.

getWorksheet(): Worksheet;

Devoluciones

ExcelScript.Worksheet

group(groupOption)

Grupos columnas y filas para un esquema.

group(groupOption: GroupOption): void;

Parámetros

groupOption

ExcelScript.GroupOption

Especifica cómo se puede agrupar el intervalo por filas o columnas. Se produce un InvalidArgument error cuando la opción de grupo difiere de la propiedad o isEntireColumn del isEntireRow intervalo (es decir, range.isEntireRow es true y groupOption es "ByColumns" o range.isEntireColumn es true y groupOption es "ByRows").

Devoluciones

void

Ejemplos

/**
 * This script creates a two-level column-based outline on Sheet1.
 */
function main(workbook: ExcelScript.Workbook) {
  // Group columns A-F in the worksheet named Sheet1.
  const sheet = workbook.getWorksheet("Sheet1");
  const firstLevel = sheet.getRange("A:F");
  firstLevel.group(ExcelScript.GroupOption.byColumns);
  
  // Create a second level to the outline by grouping subsections.
  sheet.getRange("A:B").group(ExcelScript.GroupOption.byColumns);
  sheet.getRange("D:E").group(ExcelScript.GroupOption.byColumns);
}

hideGroupDetails(groupOption)

Oculta los detalles del grupo de filas o columnas.

hideGroupDetails(groupOption: GroupOption): void;

Parámetros

groupOption

ExcelScript.GroupOption

Especifica si se ocultan los detalles de filas agrupadas o columnas agrupadas.

Devoluciones

void

insert(shift)

Inserta una celda o un intervalo de celdas en la hoja de cálculo en lugar de este intervalo y desplaza las demás celdas para crear espacio. Devuelve un nuevo Range objeto en el espacio ahora en blanco.

insert(shift: InsertShiftDirection): Range;

Parámetros

shift

ExcelScript.InsertShiftDirection

Especifica hacia dónde se desplazarán las celdas. Vea ExcelScript.InsertShiftDirection para más información.

Devoluciones

ExcelScript.Range

Ejemplos

/**
 * This script inserts headers at the top of the worksheet.
 */
function main(workbook: ExcelScript.Workbook)
{
  let currentSheet = workbook.getActiveWorksheet();

  // Create headers for 3 columns.
  let myHeaders = [["NAME", "ID", "ROLE"]];

  // Add a blank first row and push existing data down a row.
  let firstRow = currentSheet.getRange("1:1");
  firstRow.insert(ExcelScript.InsertShiftDirection.down);

  // Add the headers.
  currentSheet.getRange("A1:C1").setValues(myHeaders);
}

merge(across)

Combina las celdas del intervalo en una región de la hoja de cálculo.

merge(across?: boolean): void;

Parámetros

across

boolean

Opcional. Establézcalo true en celdas de combinación en cada fila del rango especificado como celdas combinadas independientes. El valor predeterminado es false.

Devoluciones

void

Ejemplos

/**
 * This script merges a group of cells into a single region.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active worksheet.
  const selectedSheet = workbook.getActiveWorksheet();

  // Merge cells A1 through A4.
  const range = selectedSheet.getRange("A1:A4");
  range.merge();
}

moveTo(destinationRange)

Mueve los valores de celda, el formato y las fórmulas del rango actual al intervalo de destino, reemplazando la información antigua de esas celdas. El intervalo de destino se expandirá automáticamente si es menor que el intervalo actual. No se cambian las celdas del rango de destino que están fuera del área del rango original.

moveTo(destinationRange: Range | string): void;

Parámetros

destinationRange

ExcelScript.Range | string

destinationRange Especifica el intervalo al que se moverá la información de este intervalo.

Devoluciones

void

removeDuplicates(columns, includesHeader)

Quita los valores duplicados del intervalo especificado por las columnas.

removeDuplicates(
            columns: number[],
            includesHeader: boolean
        ): RemoveDuplicatesResult;

Parámetros

columns

number[]

Columnas dentro del intervalo que pueden contener duplicados. Se debe especificar al menos una columna. Indizado con cero.

includesHeader

boolean

True si los datos de entrada contienen el encabezado . El valor predeterminado es false.

Devoluciones

ExcelScript.RemoveDuplicatesResult

Ejemplos

/**
 * This script removes duplicate rows from a range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range of the active worksheet.
  const usedRange = workbook.getActiveWorksheet().getUsedRange();

  // Remove any row that has a same value in the 0-indexed column as a previous row.
  const removedResults = usedRange.removeDuplicates([0], true);

  // Log the count of removed rows.
  console.log(`Rows removed: ${removedResults.getRemoved()}.`);
}

replaceAll(text, replacement, criteria)

Busca y reemplaza la cadena especificada, según los criterios especificados dentro del intervalo actual.

replaceAll(
            text: string,
            replacement: string,
            criteria: ReplaceCriteria
        ): number;

Parámetros

text

string

Cadena que se va a buscar.

replacement

string

Cadena que reemplaza a la cadena original.

criteria

ExcelScript.ReplaceCriteria

Criterios de reemplazo adicionales.

Devoluciones

number

Ejemplos

/**
 * This script searches through a table column and replaces  
 * cells marked "monthly special" with "parsnip".
 * This script uses Range.replaceAll instead of Worksheet.replaceAll
 * to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range of a table named "Orders".
  let table = workbook.getTable("Orders");
  let range = table.getColumnByName("Vegetable").getRange();
  
  // Change the value of any cells with the value "monthly special".
  range.replaceAll("monthly special", "parsnip", {completeMatch: true});
}

select()

Selecciona el intervalo especificado en la interfaz de usuario de Excel.

select(): void;

Devoluciones

void

Ejemplos

/**
 * This script selects the first row of a table.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table on the current worksheet.
  const sheet = workbook.getActiveWorksheet()
  const table = sheet.getTables()[0];

  // Get the first data row in the table.
  const row = table.getRangeBetweenHeaderAndTotal().getRow(0);

  // Select the first data row.
  row.select();
}

setColumnHidden(columnHidden)

Representa si todas las columnas del intervalo actual están ocultas. El valor es true cuando todas las columnas de un intervalo están ocultas. El valor es false cuando no se oculta ninguna columna del intervalo. El valor es null cuando algunas columnas de un rango están ocultas y otras columnas del mismo rango no están ocultas.

setColumnHidden(columnHidden: boolean): void;

Parámetros

columnHidden

boolean

Devoluciones

void

setDirty()

Establece un intervalo que se deberá actualizar cuando se realice la próxima actualización.

setDirty(): void;

Devoluciones

void

setFormula(formula)

Establece la fórmula de celda en notación de estilo A1. Si el rango contiene varias celdas, cada celda del rango especificado se actualizará con los datos de entrada.

setFormula(formula: string): void;

Parámetros

formula

string

Devoluciones

void

Ejemplos

/*
 * This script sets a cell's formula, 
 * then displays how Excel stores the cell's formula and value separately.
 */
function main(workbook: ExcelScript.Workbook) {
  let selectedSheet = workbook.getActiveWorksheet();

  // Set A1 to 2.
  let a1 = selectedSheet.getRange("A1");
  a1.setValue(2);

  // Set B1 to the formula =(2*A1), which should equal 4.
  let b1 = selectedSheet.getRange("B1")
  b1.setFormula("=(2*A1)");

  // Log the current results for `getFormula` and `getValue` at B1.
  console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
}

setFormulaLocal(formulaLocal)

Establezca la fórmula de celda en notación de estilo A1, en la configuración regional de formato de número y idioma del usuario. Por ejemplo, la fórmula "=SUM(A1, 1.5)" en inglés se convertiría en "=SUMME(A1; 1,5)" en alemán. Si el rango contiene varias celdas, cada celda del rango especificado se actualizará con los datos de entrada.

setFormulaLocal(formulaLocal: string): void;

Parámetros

formulaLocal

string

Devoluciones

void

setFormulaR1C1(formulaR1C1)

Establece la fórmula de celda en notación de estilo R1C1. Si el rango contiene varias celdas, cada celda del rango especificado se actualizará con los datos de entrada.

setFormulaR1C1(formulaR1C1: string): void;

Parámetros

formulaR1C1

string

Devoluciones

void

setFormulas(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.

setFormulas(formulas: string[][]): void;

Parámetros

formulas

string[][]

Devoluciones

void

Ejemplos

/**
 * This script sets the values of a range, then adds SUM formulas to calculate
 * the totals for each row of that range. 
 */
function main(workbook: ExcelScript.Workbook)
{
  let currentSheet = workbook.getActiveWorksheet();

  // Set the values of a range.
  let values = [[1, 2, 4], [8, 16, 32], [64, 128, 256]];
  let valueRange = currentSheet.getRange("A1:C3");
  valueRange.setValues(values);

  // Set the formulas of a range.
  let formulas = [["=SUM(A1:C1)"], ["=SUM(A2:C2)"], ["=SUM(A3:C3)"]];
  let formulaRange = currentSheet.getRange("D1:D3");
  formulaRange.setFormulas(formulas);
}

setFormulasLocal(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.

setFormulasLocal(formulasLocal: string[][]): void;

Parámetros

formulasLocal

string[][]

Devoluciones

void

setFormulasR1C1(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.

setFormulasR1C1(formulasR1C1: string[][]): void;

Parámetros

formulasR1C1

string[][]

Devoluciones

void

setHyperlink(hyperlink)

Representa el hipervínculo del intervalo actual.

setHyperlink(hyperlink: RangeHyperlink): void;

Parámetros

hyperlink

ExcelScript.RangeHyperlink

Devoluciones

void

Ejemplos

/** 
 * This script inserts a hyperlink to the first cell of the last worksheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  let cell = workbook.getActiveCell();

  // Get the last worksheet in the workbook.
  // Note that this might be the current sheet if there's only one worksheet.
  let lastSheet = workbook.getLastWorksheet();

  // Get sheet name. 
  let linkedSheetName = lastSheet.getName();
  console.log(`Setting hyperlink of ${cell.getAddress()} to the ${linkedSheetName} sheet's A1 cell`);

  // Set the text for the hyperlink.
  let value = `Click to go to: ${linkedSheetName}`;

  // Create the hyperlink using that cell's value.
  cell.setHyperlink({
    textToDisplay: value.toString(),
    screenTip: `Navigate to ${linkedSheetName}`,
    documentReference: `${linkedSheetName}!A1`
  });
}

setNumberFormat(numberFormat)

Establece el código de formato de número de excel de celda para el intervalo especificado. Si el rango contiene varias celdas, cada celda del rango especificado se actualizará con los datos de entrada.

setNumberFormat(numberFormat: string): void;

Parámetros

numberFormat

string

Devoluciones

void

Ejemplos

/**
 * This script sets the number format in column C to show the data as a percentage.
 */
function main(workbook: ExcelScript.Workbook) {
  const  selectedSheet = workbook.getActiveWorksheet();
  
  // Set number format for column C to a percentage that rounds to the nearest percentage point.
  selectedSheet.getRange("C:C").setNumberFormat("0%");
}

setNumberFormatLocal(numberFormatLocal)

Establece el código de formato de número de celda de Excel para el intervalo determinado, en función de la configuración de idioma del usuario. Excel no realiza ninguna coerción de idioma o formato al obtener o establecer la numberFormatLocal propiedad. Cualquier texto devuelto usa las cadenas con formato local en función del idioma especificado en la configuración del sistema. Si el rango contiene varias celdas, cada celda del rango especificado se actualizará con los datos de entrada.

setNumberFormatLocal(numberFormatLocal: string): void;

Parámetros

numberFormatLocal

string

Devoluciones

void

Ejemplos

/**
 * This script sets the number format in column D to show the data as a percentage with a decimal.
 */
function main(workbook: ExcelScript.Workbook) {
  const  selectedSheet = workbook.getActiveWorksheet();
  
  // Set number format for column D to a percentage that rounds to the nearest tenth of a percentage.
  selectedSheet.getRange("D:D").setNumberFormatLocal("0.0%");
}

setNumberFormats(numberFormats)

Representa el código de formato de número de Excel para el intervalo especificado.

setNumberFormats(numberFormats: string[][]): void;

Parámetros

numberFormats

string[][]

Devoluciones

void

setNumberFormatsLocal(numberFormatsLocal)

Representa el código de formato de número de Excel para el intervalo especificado, en función de la configuración de idioma del usuario. Excel no realiza ninguna coerción de idioma o formato al obtener o establecer la numberFormatLocal propiedad. Cualquier texto devuelto usa las cadenas con formato local en función del idioma especificado en la configuración del sistema.

setNumberFormatsLocal(numberFormatsLocal: string[][]): void;

Parámetros

numberFormatsLocal

string[][]

Devoluciones

void

setPredefinedCellStyle(predefinedCellStyle)

Representa el estilo del rango actual.

setPredefinedCellStyle(predefinedCellStyle: string): void;

Parámetros

predefinedCellStyle

string

Devoluciones

void

setRowHidden(rowHidden)

Representa si todas las filas del intervalo actual están ocultas. El valor es true cuando todas las filas de un intervalo están ocultas. El valor es false cuando no se oculta ninguna fila del intervalo. El valor es null cuando algunas filas de un rango están ocultas y otras filas del mismo rango no están ocultas.

setRowHidden(rowHidden: boolean): void;

Parámetros

rowHidden

boolean

Devoluciones

void

setValue(value)

Establece el valor sin procesar del intervalo especificado. Los datos que se establecen pueden ser de tipo cadena, número o booleano. null se omitirá el valor (no se establece ni se sobrescribe en Excel). Si el rango contiene varias celdas, cada celda del rango especificado se actualizará con los datos de entrada.

setValue(value: any): void;

Parámetros

value

any

Devoluciones

void

setValues(values)

Establece los valores sin procesar del intervalo especificado. Los datos proporcionados pueden ser una cadena, un número o un valor booleano. Si el valor proporcionado comienza con un signo más ("+"), menos ("-") o un signo igual ("="), Excel interpreta este valor como una fórmula.

setValues(values: (string | number | boolean)[][]): void;

Parámetros

values

(string | number | boolean)[][]

Devoluciones

void

Ejemplos

/**
 * This sample inserts some pre-loaded data into a range.
 * It also shows how to get a range that fits the data.
 */
 function main(workbook: ExcelScript.Workbook) {
   // Get the active cell.
   let currentCell = workbook.getActiveCell();
   
   // Calculate the range needed to fit the given data.
   let targetRange = currentCell.getResizedRange(DATA.length - 1, DATA[0].length - 1);

   // Set range values to the data.
   targetRange.setValues(DATA);

   // Autofit the columns so the worksheet is readable. 
   targetRange.getFormat().autofitColumns();
 }

 /* 
  * This sample's data is in a static 2-dimensional array.
  * You could also get the input from other ranges or sources.
  * Note that each row must have the same number of columns to be valid. 
  */
 const DATA = [
   ['Date', 'Salesperson', 'Product', 'Amount']
   , ['3/2/2020', 'Anne', 'Pizza', '$1400']
   , ['3/2/2020', 'Mariya', 'Pizza', '$1700']
   , ['3/7/2020', 'Mark', 'Sandwiches', '$1010']
   , ['3/24/2020', 'Anne', 'Pizza', '$750']
   , ['3/28/2020', 'Mark', 'Salads', '$510']
   , ['4/17/2020', 'Laura', 'Salads', '$900']
   , ['4/17/2020', 'Mariya', 'Salads', '$1600']
   , ['4/28/2020', 'Laura', 'Sandwiches', '$680']
 ];

showCard()

Muestra la tarjeta de una celda activa si tiene contenido de valor enriquecido.

showCard(): void;

Devoluciones

void

showGroupDetails(groupOption)

Muestra los detalles del grupo de filas o columnas.

showGroupDetails(groupOption: GroupOption): void;

Parámetros

groupOption

ExcelScript.GroupOption

Especifica si se deben mostrar los detalles de las filas agrupadas o las columnas agrupadas.

Devoluciones

void

ungroup(groupOption)

Desagrupa columnas y filas para un esquema.

ungroup(groupOption: GroupOption): void;

Parámetros

groupOption

ExcelScript.GroupOption

Especifica cómo se puede desagrupar el intervalo por filas o columnas.

Devoluciones

void

unmerge()

Separa las celdas del intervalo en celdas independientes.

unmerge(): void;

Devoluciones

void

Ejemplos

/**
 * This script unmerges every used cell in the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active worksheet.
  const selectedSheet = workbook.getActiveWorksheet();

  // Separate all regions into single cells in the currently used range.
  const range = selectedSheet.getUsedRange();
  range.unmerge();
}