ExcelScript.Range interface

Adiciona um novo formato condicional à coleção na prioridade primeira/superior.

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Parâmetros

Retornos

Exemplos

/**
 * 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.
  });
}

Preenche um intervalo do intervalo atual para o intervalo de destino usando a lógica de AutoPreenchimento especificada. O intervalo de destino pode ser null ou pode estender o intervalo de origem horizontal ou verticalmente. Intervalos descontíguos não são suportados.

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

Parâmetros

Retornos

Exemplos

/**
 * 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");
}

Calcula um intervalo de células em uma planilha.

calculate(): void;

Retornos

Exemplos

/**
 * 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();
  }
}

Limpe os valores e a formatação do intervalo, como preenchimento e borda.

clear(applyTo?: ClearApplyTo): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Limpa todos os formatos condicionais ativos no intervalo atual especificado.

clearAllConditionalFormats(): void;

Retornos

Limpa os valores das células no intervalo, com consideração especial dada às células que contêm controles. Se o intervalo contiver apenas valores em branco e controles definidos com seu valor padrão, os valores e a formatação de controle serão removidos. Caso contrário, isso definirá as células com controles para seu valor padrão e limpará os valores das outras células no intervalo.

clearOrResetContents(): void;

Retornos

Converte as células do intervalo com tipos de dados em texto.

convertDataTypeToText(): void;

Retornos

Copia os dados da célula ou a formatação do intervalo de origem ou RangeAreas para o intervalo atual. O intervalo de destino pode ter um tamanho diferente do intervalo de origem ou RangeAreas. O destino será expandido automaticamente se for menor que a origem. Observação: Como a funcionalidade de cópia na interface do usuário do Excel, se o intervalo de destino for um múltiplo exato maior que o intervalo de origem em linhas ou colunas, o conteúdo de origem será replicado várias vezes. Por exemplo, uma cópia de intervalo 2x2 para um intervalo 2x6 resultará em 3 cópias do intervalo 2x2 original.

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

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Exclui as células associadas ao intervalo.

delete(shift: DeleteShiftDirection): void;

Parâmetros

Retornos

Exemplos

/**
 * 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()); 
}

Localiza certa cadeia de caracteres com base em critérios especificados. Se o intervalo atual for maior do que uma única célula, a pesquisa será limitada a esse intervalo; caso contrário, a pesquisa cobrirá toda a planilha que começa após essa célula. Se não houver correspondências, esse método retornará undefined.

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

Parâmetros

Retornos

Exemplos

/**
 * 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 });
  }
}

Faz um preenchimento relâmpago para o intervalo atual. O Preenchimento Relâmpago preenche automaticamente os dados quando detecta um padrão, portanto, o intervalo deve ser um intervalo de uma única coluna e ter dados ao seu redor para encontrar um padrão.

flashFill(): void;

Retornos

Exemplos

/**
 * 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();
}

Obtém um Range objeto com a mesma célula superior esquerda que o objeto atual Range , mas com o número especificado de linhas e colunas.

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

Parâmetros

Retornos

Especifica a referência de intervalo no estilo A1. O valor do endereço contém a referência de planilha (por exemplo, "Planilha1! A1:B4").

getAddress(): string;

Retornos

Exemplos

/**
 * 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());
  });
}

Representa a referência de intervalo para o intervalo especificado no idioma do usuário.

getAddressLocal(): string;

Retornos

Obtém o menor objeto de intervalo que abrange os intervalos determinados. Por exemplo, " GetBoundingRect B2:C5" e "D10:E15" é "B2:E15".

getBoundingRect(anotherRange: Range | string): Range;

Parâmetros

Retornos

Exemplos

/**
 * 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
}

Obtém o objeto de intervalo que contém a célula única com base nos números de linha e de coluna. A célula pode estar fora dos limites de seu intervalo pai, desde que permaneça dentro da grade da planilha. A localização da célula retornada está relacionada à célula superior esquerda do intervalo.

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

Parâmetros

Retornos

Especifica o número de células no intervalo. Essa API retornará -1 se a contagem de células exceder 2^31-1 (2.147.483.647).

getCellCount(): number;

Retornos

Obtém uma coluna incluída no intervalo.

getColumn(column: number): Range;

Parâmetros

Retornos

Especifica o número total de colunas no intervalo.

getColumnCount(): number;

Retornos

Exemplos

/**
 * 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);
}

Representa se todas as colunas no intervalo atual estão ocultas. Valor é true quando todas as colunas em um intervalo estão ocultas. Valor é false quando nenhuma coluna no intervalo está oculta. Valor é null quando algumas colunas em um intervalo estão ocultas e outras colunas no mesmo intervalo não estão ocultas.

getColumnHidden(): boolean;

Retornos

Especifica o número da coluna da primeira célula do intervalo. Indexados com zero.

getColumnIndex(): number;

Retornos

Obtém um determinado número de colunas à direita do objeto atual Range .

getColumnsAfter(count?: number): Range;

Parâmetros

Retornos

Obtém um determinado número de colunas à esquerda do objeto atual Range .

getColumnsBefore(count?: number): Range;

Parâmetros

Retornos

Retorna um formato condicional identificado por sua ID. Se o objeto de formato condicional não existir, esse método retornará undefined.

getConditionalFormat(id: string): ConditionalFormat | undefined;

Parâmetros

Retornos

A coleção dessa ConditionalFormats interseção a cordilheira.

getConditionalFormats(): ConditionalFormat[];

Retornos

Acessa o controle de célula aplicado a esse intervalo. Se o intervalo tiver vários controles de célula, isso retornará EmptyCellControl.

getControl(): CellControl;

Retornos

Retorna um objeto de validação de dados.

getDataValidation(): DataValidation;

Retornos

Exemplos

/**
 * 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
      }
    });
}

Retorna um WorkbookRangeAreas objeto que representa o intervalo que contém todas as células dependentes de um intervalo especificado na mesma planilha ou em várias planilhas. Gera um ItemNotFound erro se nenhum dependente for encontrado.

getDependents(): WorkbookRangeAreas;

Retornos

Retorna um WorkbookRangeAreas objeto que representa o intervalo que contém todas as células dependentes diretas de um intervalo especificado na mesma planilha ou em várias planilhas. Gera um ItemNotFound erro se nenhum dependente for encontrado.

getDirectDependents(): WorkbookRangeAreas;

Retornos

Retorna um WorkbookRangeAreas objeto que representa o intervalo que contém todas as células de precedente direta de um intervalo especificado na mesma planilha ou em várias planilhas. Gera um ItemNotFound erro se nenhum precedente for encontrado.

getDirectPrecedents(): WorkbookRangeAreas;

Retornos

Exemplos

/**
 * 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);
  });
}

Obtém um objeto que representa a coluna inteira do intervalo (por exemplo, se o intervalo atual representa as células "B4:E11", é getEntireColumn um intervalo que representa as colunas "B:E").

getEntireColumn(): Range;

Retornos

Obtém um objeto que representa a linha inteira do intervalo (por exemplo, se o intervalo atual representa as células "B4:E11", é GetEntireRow um intervalo que representa as linhas "4:11").

getEntireRow(): Range;

Retornos

Retorna um objeto de intervalo que inclui o intervalo atual e até a borda do intervalo, com base na direção fornecida. Isso corresponde ao comportamento da tecla Ctrl+Shift+Direção na interface do usuário do Excel no Windows.

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

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Retorna um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo.

getFormat(): RangeFormat;

Retornos

Exemplos

/**
 * 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");
}

Representa a fórmula da célula em notação de estilo A1. Se o intervalo contiver várias células, os dados da primeira célula (representada pelo índice de linha 0 e índice de coluna 0) serão retornados.

getFormula(): string;

Retornos

Exemplos

/*
 * 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()}`);
}

Representa a fórmula da célula em notação no estilo A1, no idioma do usuário e na localidade de formatação de número. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se o intervalo contiver várias células, os dados da primeira célula (representada pelo índice de linha 0 e índice de coluna 0) serão retornados.

getFormulaLocal(): string;

Retornos

Representa a fórmula da célula em notação de estilo R1C1. Se o intervalo contiver várias células, os dados da primeira célula (representada pelo índice de linha 0 e índice de coluna 0) serão retornados.

getFormulaR1C1(): string;

Retornos

Representa a fórmula em notação A1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

getFormulas(): string[][];

Retornos

Representa a fórmula em notação A1, na formatação de número da localidade e no idioma do usuário. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

getFormulasLocal(): string[][];

Retornos

Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

getFormulasR1C1(): string[][];

Retornos

Representa se todas as células têm uma borda de despejo. Retorna true se todas as células tiverem uma borda de despejo ou false se todas as células não tiverem uma borda de despejo. Retorna null se houver células com e sem bordas de despejo dentro do intervalo.

getHasSpill(): boolean;

Retornos

Retorna a distância em pontos, para um zoom de 100%, da borda superior do intervalo até a borda inferior do intervalo.

getHeight(): number;

Retornos

Representa se todas as células no intervalo atual estão ocultas. Valor é true quando todas as células em um intervalo estão ocultas. Valor é false quando nenhuma célula do intervalo está oculta. O valor é null quando algumas células de um intervalo estão ocultas e outras células do mesmo intervalo não estão ocultas.

getHidden(): boolean;

Retornos

Representa o hiperlink para o intervalo atual.

getHyperlink(): RangeHyperlink;

Retornos

Exemplos

/**
 * 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`);
}

Renderiza o intervalo como uma imagem PNG codificada em Base64.

getImage(): string;

Retornos

Obtém o objeto de intervalo que representa a interseção retangular dos intervalos determinados. Se nenhuma interseção for encontrada, esse método retornará undefined.

getIntersection(anotherRange: Range | string): Range;

Parâmetros

Retornos

Representa se o intervalo atual está em uma coluna inteira.

getIsEntireColumn(): boolean;

Retornos

Representa se o intervalo atual está em uma linha inteira.

getIsEntireRow(): boolean;

Retornos

Obtém a última célula do intervalo. Por exemplo, a última célula de "B2:D5" é "D5".

getLastCell(): Range;

Retornos

Obtém a última coluna do intervalo. Por exemplo, a última coluna de "B2:D5" é "D2:D5".

getLastColumn(): Range;

Retornos

Obtém a última linha do intervalo. Por exemplo, a última linha de "B2:D5" é "B5:D5".

getLastRow(): Range;

Retornos

Retorna a distância em pontos, para um zoom de 100%, da borda esquerda da planilha até a borda esquerda do intervalo.

getLeft(): number;

Retornos

Representa o estado do tipo de dados da célula.

getLinkedDataTypeState(): LinkedDataTypeState;

Retornos

Representa o estado do tipo de dados de cada célula.

getLinkedDataTypeStates(): LinkedDataTypeState[][];

Retornos

Retorna um RangeAreas objeto que representa as áreas mescladas nesse intervalo. Observe que, se a contagem de áreas mescladas nesse intervalo for maior que 512, esse método não retornará o resultado. Se o RangeAreas objeto não existir, essa função retornará undefined.

getMergedAreas(): RangeAreas;

Retornos

Representa o código de formato de número do Excel da célula para o intervalo determinado. Se o intervalo contiver várias células, os dados da primeira célula (representada pelo índice de linha 0 e índice de coluna 0) serão retornados.

getNumberFormat(): string;

Retornos

Representa a categoria do formato de número de cada célula.

getNumberFormatCategories(): NumberFormatCategory[][];

Retornos

Exemplos

/**
 * 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");
    }
  }); 
}

Especifica a categoria de formato de número da primeira célula no intervalo (representada pelo índice de linha 0 e índice de coluna de 0).

getNumberFormatCategory(): NumberFormatCategory;

Retornos

Representa o código de formato de número do Excel de célula para determinado intervalo, com base nas configurações de idioma do usuário. O Excel não executa nenhuma coerção de idioma ou formato ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema. Se o intervalo contiver várias células, os dados da primeira célula (representada pelo índice de linha 0 e índice de coluna 0) serão retornados.

getNumberFormatLocal(): string;

Retornos

Representa o código de formato de número do Excel para determinado intervalo.

getNumberFormats(): string[][];

Retornos

Representa o código de formato de número do Excel para determinado intervalo, com base nas configurações de idioma do usuário. O Excel não executa nenhuma coerção de idioma ou formato ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema.

getNumberFormatsLocal(): string[][];

Retornos

Obtém um objeto que representa um intervalo deslocado do intervalo especificado. A dimensão do intervalo retornado corresponde a esse intervalo. Se o intervalo resultante for imposto para fora dos limites da grade da planilha, o sistema gerará um erro.

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

Parâmetros

Retornos

Exemplos

/**
 * 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");
}

Obtém uma coleção com escopo de Tabelas Dinâmicas que se sobrepõem ao intervalo.

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

Parâmetros

Retornos

Retorna um WorkbookRangeAreas objeto que representa o intervalo que contém todas as células precedentes de um intervalo especificado na mesma planilha ou em várias planilhas. Gera um ItemNotFound erro se nenhum precedente for encontrado.

getPrecedents(): WorkbookRangeAreas;

Retornos

Representa o estilo de intervalo atual. Se os estilos das células forem inconsistentes, null será retornado. Para estilos personalizados, o nome do estilo será retornado. Para estilos internos, uma cadeia de caracteres que representa um valor na enumeração BuiltInStyle será retornada.

getPredefinedCellStyle(): string;

Retornos

Retorna um objeto de intervalo que é a célula de borda da região de dados que corresponde à direção fornecida. Isso corresponde ao comportamento da tecla Ctrl+Direção na interface do usuário do Excel no Windows.

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

Parâmetros

Retornos

Exemplos

/**
 * 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");
}

Obtém um Range objeto semelhante ao objeto atual Range , mas com seu canto inferior direito expandido (ou contraído) por um certo número de linhas e colunas.

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

Parâmetros

Retornos

Exemplos

/**
 * 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. */
  );
}

Obtém uma linha contida no intervalo.

getRow(row: number): Range;

Parâmetros

Retornos

Retorna o número total de linhas no intervalo.

getRowCount(): number;

Retornos

Exemplos

/**
 * 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);
}

Representa se todas as linhas no intervalo atual estão ocultas. O valor é true quando todas as linhas em um intervalo estão ocultas. O valor é false quando nenhuma linha no intervalo está oculta. O valor é null quando algumas linhas em um intervalo estão ocultas e outras linhas no mesmo intervalo não estão ocultas.

getRowHidden(): boolean;

Retornos

Representa o número de linhas da primeira célula no intervalo. Indexados com zero.

getRowIndex(): number;

Retornos

Obtém um determinado número de linhas acima do objeto atual Range .

getRowsAbove(count?: number): Range;

Parâmetros

Retornos

Obtém um determinado número de linhas abaixo do objeto atual Range .

getRowsBelow(count?: number): Range;

Parâmetros

Retornos

Representa se todas as células seriam salvas como uma fórmula de matriz. Retorna true se todas as células forem salvas como uma fórmula de matriz ou false se todas as células não forem salvas como uma fórmula de matriz. Retorna null se algumas células seriam salvas como uma fórmula de matriz e outras não.

getSavedAsArray(): boolean;

Retornos

Representa a classificação de intervalo do intervalo atual.

getSort(): RangeSort;

Retornos

Obtém o RangeAreas objeto, compreendendo um ou mais intervalos, que representa todas as células que correspondem ao tipo e valor especificados. Se nenhuma célula especial for encontrada, esse método retornará undefined.

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

Parâmetros

Retornos

Exemplos

/**
 * 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");
}

Obtém objeto range que contém o intervalo de despejo quando chamado em uma célula âncora. Se o intervalo não for uma célula âncora ou o intervalo de derramamento não puder ser encontrado, esse método retornará undefined.

getSpillingToRange(): Range;

Retornos

Obtém o objeto de intervalo que contém a célula âncora da célula que está sendo despejada. Se não for uma célula despejada ou mais de uma célula for fornecida, esse método retornará undefined.

getSpillParent(): Range;

Retornos

Retorna um Range objeto que representa a região ao redor da célula superior esquerda nesse intervalo. Uma região ao redor é um intervalo limitado por qualquer combinação de linhas e colunas em branco em relação a esse intervalo.

getSurroundingRegion(): Range;

Retornos

Obtém uma coleção de tabelas com escopo que se sobrepõe ao intervalo.

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

Parâmetros

Retornos

Representa o valor de Texto do intervalo especificado. O valor de texto não depende da largura da célula. A substituição pelo sinal #, que ocorre na interface de usuário do Excel, não afeta o valor de texto retornado pela API. Se o intervalo contiver várias células, os dados da primeira célula (representada pelo índice de linha 0 e índice de coluna 0) serão retornados.

getText(): string;

Retornos

Valores de texto do intervalo especificado. O valor de texto não depende da largura da célula. A substituição do sinal de número (#) que ocorre na interface do usuário do Excel não afetará o valor de texto retornado pela API.

getTexts(): string[][];

Retornos

Retorna a distância em pontos, para um zoom de 100%, da borda superior da planilha até a borda superior do intervalo.

getTop(): number;

Retornos

Retorna o intervalo usado do objeto de intervalo determinado. Se não houver células usadas no intervalo, esse método retornará undefined.

getUsedRange(valuesOnly?: boolean): Range;

Parâmetros

Retornos

Representa o valor bruto do intervalo especificado. Os dados retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o intervalo contiver várias células, os dados da primeira célula (representada pelo índice de linha 0 e índice de coluna 0) serão retornados.

getValue(): string | number | boolean;

Retornos

Exemplos

/**
 * 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());
}

Representa os valores brutos do intervalo especificado. Os dados retornados podem ser uma cadeia de caracteres, um número ou um booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor retornado começar com um sinal de mais ("+"), sinal de subtração ("-") ou sinal de igual ("="), o Excel interpretará esse valor como uma fórmula.

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

Retornos

Representa o tipo de dados na célula. Se o intervalo contiver várias células, os dados da primeira célula (representada pelo índice de linha 0 e índice de coluna 0) serão retornados.

getValueType(): RangeValueType;

Retornos

Exemplos

/**
 * 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);
    }
  }
}

Especifica o tipo de dados em cada célula.

getValueTypes(): RangeValueType[][];

Retornos

Representa as linhas visíveis do intervalo atual.

getVisibleView(): RangeView;

Retornos

Exemplos

/**
 * 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);
}

Retorna a distância em pontos, para um zoom de 100%, da borda esquerda do intervalo até a borda direita do intervalo.

getWidth(): number;

Retornos

A planilha que contém o intervalo atual.

getWorksheet(): Worksheet;

Retornos

Agrupa colunas e linhas para obter uma estrutura de tópicos.

group(groupOption: GroupOption): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Oculta os detalhes do grupo de linha ou coluna.

hideGroupDetails(groupOption: GroupOption): void;

Parâmetros

Retornos

Insere uma célula ou um intervalo de células na planilha, no lugar desse intervalo, e desloca as outras células para liberar espaço. Retorna um novo Range objeto com espaço em branco.

insert(shift: InsertShiftDirection): Range;

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Mescla as células do intervalo em uma região da planilha.

merge(across?: boolean): void;

Parâmetros

Retornos

Exemplos

/**
 * 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();
}

Move valores de célula, formatação e fórmulas do intervalo atual para o intervalo de destino, substituindo as informações antigas nessas células. O intervalo de destino será expandido automaticamente se for menor que o intervalo atual. As células no intervalo de destino que estão fora da área do intervalo original não são alteradas.

moveTo(destinationRange: Range | string): void;

Parâmetros

Retornos

Remove valores duplicados do intervalo especificado pelas colunas.

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

Parâmetros

Retornos

Exemplos

/**
 * 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()}.`);
}

Localiza e substitui a cadeia de caracteres fornecida com base nos critérios especificados no intervalo atual.

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

Parâmetros

Retornos

Exemplos

/**
 * 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});
}

Seleciona o intervalo especificado na interface do usuário do Excel.

select(): void;

Retornos

Exemplos

/**
 * 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();
}

Representa se todas as colunas no intervalo atual estão ocultas. Valor é true quando todas as colunas em um intervalo estão ocultas. Valor é false quando nenhuma coluna no intervalo está oculta. Valor é null quando algumas colunas em um intervalo estão ocultas e outras colunas no mesmo intervalo não estão ocultas.

setColumnHidden(columnHidden: boolean): void;

Parâmetros

Retornos

Acessa o controle de célula aplicado a esse intervalo. Se o intervalo tiver vários controles de célula, isso retornará EmptyCellControl.

setControl(control: CellControl): void;

Parâmetros

Retornos

Define um intervalo a ser recalculado quando o próximo recálculo ocorrer.

setDirty(): void;

Retornos

Define a fórmula da célula em notação de estilo A1. Se o intervalo contiver várias células, cada célula no intervalo fornecido será atualizada com os dados de entrada.

setFormula(formula: string): void;

Parâmetros

Retornos

Exemplos

/*
 * 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()}`);
}

Defina a fórmula da célula em notação no estilo A1, no idioma do usuário e na localidade de formatação de número. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se o intervalo contiver várias células, cada célula no intervalo fornecido será atualizada com os dados de entrada.

setFormulaLocal(formulaLocal: string): void;

Parâmetros

Retornos

Define a fórmula da célula em notação de estilo R1C1. Se o intervalo contiver várias células, cada célula no intervalo fornecido será atualizada com os dados de entrada.

setFormulaR1C1(formulaR1C1: string): void;

Parâmetros

Retornos

Representa a fórmula em notação A1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

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

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Representa a fórmula em notação A1, na formatação de número da localidade e no idioma do usuário. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

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

Parâmetros

Retornos

Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

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

Parâmetros

Retornos

Representa o hiperlink para o intervalo atual.

setHyperlink(hyperlink: RangeHyperlink): void;

Parâmetros

Retornos

Exemplos

/** 
 * 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`
  });
}

Define o código de formato de número do Excel de célula para determinado intervalo. Se o intervalo contiver várias células, cada célula no intervalo fornecido será atualizada com os dados de entrada.

setNumberFormat(numberFormat: string): void;

Parâmetros

Retornos

Exemplos

/**
 * 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%");
}

Define o código de formato de número do Excel de célula para determinado intervalo, com base nas configurações de idioma do usuário. O Excel não executa nenhuma coerção de idioma ou formato ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema. Se o intervalo contiver várias células, cada célula no intervalo fornecido será atualizada com os dados de entrada.

setNumberFormatLocal(numberFormatLocal: string): void;

Parâmetros

Retornos

Exemplos

/**
 * 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%");
}

Representa o código de formato de número do Excel para determinado intervalo.

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

Parâmetros

Retornos

Representa o código de formato de número do Excel para determinado intervalo, com base nas configurações de idioma do usuário. O Excel não executa nenhuma coerção de idioma ou formato ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema.

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

Parâmetros

Retornos

Representa o estilo de intervalo atual.

setPredefinedCellStyle(predefinedCellStyle: string): void;

Parâmetros

Retornos

Representa se todas as linhas no intervalo atual estão ocultas. O valor é true quando todas as linhas em um intervalo estão ocultas. O valor é false quando nenhuma linha no intervalo está oculta. O valor é null quando algumas linhas em um intervalo estão ocultas e outras linhas no mesmo intervalo não estão ocultas.

setRowHidden(rowHidden: boolean): void;

Parâmetros

Retornos

Define o valor bruto do intervalo especificado. Os dados que estão sendo definidos podem ser do tipo string, número ou booliano. null valor será ignorado (não definido ou substituído no Excel). Se o intervalo contiver várias células, cada célula no intervalo fornecido será atualizada com os dados de entrada.

setValue(value: any): void;

Parâmetros

Retornos

Define os valores brutos do intervalo especificado. Os dados fornecidos podem ser uma cadeia de caracteres, um número ou um booleano. Se o valor fornecido começar com um sinal de mais ("+"), sinal de menos ("-") ou sinal de igual ("="), o Excel interpretará esse valor como uma fórmula.

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

Parâmetros

Retornos

Exemplos

/**
 * 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']
 ];

Exibe o cartão para uma célula ativa se ele tiver um conteúdo valioso.

showCard(): void;

Retornos

Mostra os detalhes do grupo de linhas ou colunas.

showGroupDetails(groupOption: GroupOption): void;

Parâmetros

Retornos

Desagrupa colunas e linhas para criar uma estrutura de tópicos.

ungroup(groupOption: GroupOption): void;

Parâmetros

Retornos

Desfaz a mesclagem das células do intervalo em células separadas.

unmerge(): void;

Retornos

Exemplos

/**
 * 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();
}