ExcelScript.RangeAreas interface

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

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Parâmetros

Retornos

Calcula todas as células no campo RangeAreas.

calculate(): void;

Retornos

Limpa valores, formato, preenchimento, borda e outras propriedades em cada uma das áreas que compõem este RangeAreas objeto.

clear(applyTo?: ClearApplyTo): void;

Parâmetros

Retornos

Exemplos

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

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

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

Limpa todos os formatos condicionais ativos no intervalo atual especificado.

clearAllConditionalFormats(): void;

Retornos

Limpa os valores das células nos intervalos, com consideração especial para as células que contêm controles. Se os intervalos contiverem 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 nos intervalos.

clearOrResetContents(): void;

Retornos

Converte em texto todas as células dos RangeAreas tipos de dados com.

convertDataTypeToText(): void;

Retornos

Copia os dados da célula ou a formatação do intervalo de origem ou RangeAreas para o arquivo .RangeAreas O destino RangeAreas pode ter um tamanho diferente do intervalo de origem ou RangeAreas. O destino será expandido automaticamente se for menor que a origem.

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

Parâmetros

Retornos

Retorna a RangeAreas referência no estilo A1. O valor do endereço conterá o nome da planilha para cada bloco retangular de células (por exemplo, "Planilha1! A1:B4, Planilha1! D1:D4").

getAddress(): string;

Retornos

Retorna a RangeAreas referência na localidade do usuário.

getAddressLocal(): string;

Retornos

Retorna o número de intervalos retangulares que compõem esse RangeAreas objeto.

getAreaCount(): number;

Retornos

Retorna uma coleção de intervalos retangulares que compõem esse RangeAreas objeto.

getAreas(): Range[];

Retornos

Retorna o número de células no RangeAreas objeto, somando as contagens de células de todos os intervalos retangulares individuais. Retornará -1 se a contagem de células exceder 2^31-1 (2.147.483.647).

getCellCount(): number;

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

Retorna uma coleção de formatos condicionais que se cruzam com qualquer célula nesse RangeAreas objeto.

getConditionalFormats(): ConditionalFormat[];

Retornos

Retorna um objeto de validação de dados para todos os intervalos no campo RangeAreas.

getDataValidation(): DataValidation;

Retornos

Retorna um RangeAreas objeto que representa as colunas inteiras do RangeAreas (por exemplo, se o atual RangeAreas representa as células "B4:E11, H2", ele retorna um que representa as RangeAreas colunas "B:E, H:H").

getEntireColumn(): RangeAreas;

Retornos

Retorna um RangeAreas objeto que representa as linhas inteiras do (por exemplo, se o atual RangeAreas representa as células "B4:E11", ele retorna um que representa as RangeAreasRangeAreas linhas "4:11").

getEntireRow(): RangeAreas;

Retornos

Retorna um RangeFormat objeto, encapsulando a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades para todos os intervalos no RangeAreas objeto.

getFormat(): RangeFormat;

Retornos

Exemplos

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

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

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

Retorna o RangeAreas objeto que representa a interseção dos intervalos fornecidos ou RangeAreas. Se nenhuma interseção for encontrada, esse método retornará undefined.

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

Parâmetros

Retornos

Especifica se todos os intervalos nesse RangeAreas objeto representam colunas inteiras (por exemplo, "A:C, Q:Z").

getIsEntireColumn(): boolean;

Retornos

Especifica se todos os intervalos nesse RangeAreas objeto representam linhas inteiras (por exemplo, "1:3, 5:7").

getIsEntireRow(): boolean;

Retornos

Retorna um RangeAreas objeto que é deslocado pelo deslocamento de linha e coluna específico. A dimensão do objeto retornado RangeAreas corresponderá ao objeto original. Se o resultado RangeAreas for forçado para fora dos limites da grade da planilha, um erro será gerado.

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

Parâmetros

Retornos

Representa o estilo de todos os intervalos neste RangeAreas objeto. 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 RangeAreas objeto que representa todas as células que correspondem ao tipo e valor especificados. Se nenhuma célula especial for encontrada que corresponda aos critérios, esse método retornará undefined.

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

Parâmetros

Retornos

Retorna uma coleção de tabelas com escopo que se sobrepõem a qualquer intervalo neste RangeAreas objeto.

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

Parâmetros

Retornos

Retorna o usado RangeAreas que compreende todas as áreas usadas de intervalos retangulares individuais no RangeAreas objeto. Se não houver células usadas dentro do RangeAreas, então esse método retornará undefined.

getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;

Parâmetros

Retornos

Retorna a planilha para o arquivo .RangeAreas

getWorksheet(): Worksheet;

Retornos

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

setDirty(): void;

Retornos

Representa o estilo de todos os intervalos neste RangeAreas objeto. 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.

setPredefinedCellStyle(predefinedCellStyle: string): void;

Parâmetros

Retornos

Exemplos

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

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

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