ExcelScript.RangeAreas interface

Referência

Pacote:: ExcelScript

RangeAreas representa uma coleção de um ou mais intervalos retangulares na mesma folha de cálculo.

Comentários

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

Métodos

addConditionalFormat(type)	Adiciona um novo formato condicional à coleção na primeira/prioridade máxima.
calculate()	Calcula todas as células no `RangeAreas`.
clear(applyTo)	Limpa valores, formato, preenchimento, limite e outras propriedades em cada uma das áreas que compõem este `RangeAreas` objeto.
clearAllConditionalFormats()	Limpa todos os formatos condicionais ativos no intervalo atual especificado.
convertDataTypeToText()	Converte todas as células em `RangeAreas` com tipos de dados em texto.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Copia dados de células ou formatação do intervalo de origem ou `RangeAreas` para o atual `RangeAreas`. O destino `RangeAreas` pode ter um tamanho diferente do intervalo de origem ou `RangeAreas`. O destino será expandido automaticamente se for menor do que a origem.
getAddress()	Devolve a `RangeAreas` referência no estilo A1. O valor do endereço conterá o nome da folha de cálculo para cada bloco retangular de células (por exemplo, "Folha1! A1:B4, Folha1! D1:D4").
getAddressLocal()	Devolve a `RangeAreas` referência na região do utilizador.
getAreaCount()	Devolve o número de intervalos retangulares que compõem este `RangeAreas` objeto.
getAreas()	Devolve uma coleção de intervalos retangulares que compõem este `RangeAreas` objeto.
getCellCount()	Devolve 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).
getConditionalFormat(id)	Devolve um formato condicional identificado pelo respetivo ID. Se o objeto de formato condicional não existir, este método devolve `undefined`.
getConditionalFormats()	Devolve uma coleção de formatos condicionais que se cruzam com quaisquer células neste `RangeAreas` objeto.
getDataValidation()	Devolve um objeto de validação de dados para todos os intervalos no `RangeAreas`.
getEntireColumn()	Devolve um `RangeAreas` objeto que representa todas as colunas do `RangeAreas` (por exemplo, se a corrente `RangeAreas` representar as células "B4:E11, H2", devolve uma `RangeAreas` que representa as colunas "B:E, H:H").
getEntireRow()	Devolve um `RangeAreas` objeto que representa todas as linhas do `RangeAreas` (por exemplo, se a corrente `RangeAreas` representar as células "B4:E11", devolve uma `RangeAreas` que representa as linhas "4:11").
getFormat()	Devolve um `RangeFormat` objeto, encapsulando o tipo de letra, o preenchimento, os limites, o alinhamento e outras propriedades para todos os intervalos no `RangeAreas` objeto.
getIntersection(anotherRange)	Devolve o `RangeAreas` objeto que representa a interseção dos intervalos especificados ou `RangeAreas`. Se não for encontrada nenhuma interseção, este método devolve `undefined`.
getIsEntireColumn()	Especifica se todos os intervalos neste `RangeAreas` objeto representam colunas inteiras (por exemplo, "A:C, Q:Z").
getIsEntireRow()	Especifica se todos os intervalos neste `RangeAreas` objeto representam linhas inteiras (por exemplo, "1:3, 5:7").
getOffsetRangeAreas(rowOffset, columnOffset)	Devolve um `RangeAreas` objeto que é movido pelo desvio de linhas e colunas específico. A dimensão do devolvido `RangeAreas` corresponderá ao objeto original. Se o resultado `RangeAreas` for forçado fora dos limites da grelha da folha de cálculo, será gerado um erro.
getPredefinedCellStyle()	Representa o estilo de todos os intervalos neste `RangeAreas` objeto. Se os estilos das células forem inconsistentes, `null` serão devolvidos. Para estilos personalizados, o nome do estilo será devolvido. Para estilos incorporados, será devolvida uma cadeia que representa um valor na `BuiltInStyle` enumeração.
getSpecialCells(cellType, cellValueType)	Devolve um `RangeAreas` objeto que representa todas as células que correspondem ao tipo e valor especificados. Se não forem encontradas células especiais que correspondam aos critérios, este método devolve `undefined`.
getTables(fullyContained)	Devolve uma coleção de tabelas no âmbito que se sobrepõem a qualquer intervalo neste `RangeAreas` objeto.
getUsedRangeAreas(valuesOnly)	Devolve o utilizado `RangeAreas` que compreende todas as áreas utilizadas de intervalos retangulares individuais no `RangeAreas` objeto. Se não existirem células utilizadas no `RangeAreas`, este método devolve `undefined`.
getWorksheet()	Devolve a folha de cálculo do atual `RangeAreas`.
setDirty()	Define o `RangeAreas` para ser recalculado quando ocorrer o próximo recálculo.
setPredefinedCellStyle(predefinedCellStyle)	Representa o estilo de todos os intervalos neste `RangeAreas` objeto. Se os estilos das células forem inconsistentes, `null` serão devolvidos. Para estilos personalizados, o nome do estilo será devolvido. Para estilos incorporados, será devolvida uma cadeia que representa um valor na `BuiltInStyle` enumeração.

Detalhes do método

addConditionalFormat(type)

Adiciona um novo formato condicional à coleção na primeira/prioridade máxima.

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Parâmetros

type: ExcelScript.ConditionalFormatType

O tipo de formato condicional a ser adicionado. Veja ExcelScript.ConditionalFormatType para obter detalhes.

Retornos

ExcelScript.ConditionalFormat

calculate()

Calcula todas as células no RangeAreas.

calculate(): void;

Retornos

void

clear(applyTo)

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

clear(applyTo?: ClearApplyTo): void;

Parâmetros

applyTo: ExcelScript.ClearApplyTo

Opcional. Determina o tipo de ação clara. Veja ExcelScript.ClearApplyTo para obter detalhes. A predefinição é "Tudo".

Retornos

void

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

clearAllConditionalFormats()

Limpa todos os formatos condicionais ativos no intervalo atual especificado.

clearAllConditionalFormats(): void;

Retornos

void

convertDataTypeToText()

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

convertDataTypeToText(): void;

Retornos

void

copyFrom(sourceRange, copyType, skipBlanks, transpose)

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

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

Parâmetros

sourceRange: ExcelScript.Range | ExcelScript.RangeAreas | string

O intervalo de origem ou RangeAreas a partir do quais copiar. Quando a origem RangeAreas tem múltiplos intervalos, o respetivo formulário tem de ser criado ao remover linhas ou colunas completas de um intervalo retangular.

copyType: ExcelScript.RangeCopyType

O tipo de dados de célula ou formatação a copiar. A predefinição é "Tudo".

skipBlanks: boolean

Verdadeiro se ignorar células em branco no intervalo de origem ou RangeAreas. O padrão é false.

transpose: boolean

Verdadeiro se transpor as células no destino RangeAreas. O padrão é false.

Retornos

void

getAddress()

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

getAddress(): string;

Retornos

string

getAddressLocal()

Devolve a RangeAreas referência na região do utilizador.

getAddressLocal(): string;

Retornos

string

getAreaCount()

Devolve o número de intervalos retangulares que compõem este RangeAreas objeto.

getAreaCount(): number;

Retornos

number

getAreas()

Devolve uma coleção de intervalos retangulares que compõem este RangeAreas objeto.

getAreas(): Range[];

Retornos

ExcelScript.Range[]

getCellCount()

Devolve 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

number

getConditionalFormat(id)

Devolve um formato condicional identificado pelo respetivo ID. Se o objeto de formato condicional não existir, este método devolve undefined.

getConditionalFormat(id: string): ConditionalFormat | undefined;

Parâmetros

id: string

O ID do formato condicional.

Retornos

ExcelScript.ConditionalFormat | undefined

getConditionalFormats()

Devolve uma coleção de formatos condicionais que se cruzam com quaisquer células neste RangeAreas objeto.

getConditionalFormats(): ConditionalFormat[];

Retornos

ExcelScript.ConditionalFormat[]

getDataValidation()

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

getDataValidation(): DataValidation;

Retornos

ExcelScript.DataValidation

getEntireColumn()

Devolve um RangeAreas objeto que representa todas as colunas do RangeAreas (por exemplo, se a corrente RangeAreas representar as células "B4:E11, H2", devolve uma RangeAreas que representa as colunas "B:E, H:H").

getEntireColumn(): RangeAreas;

Retornos

ExcelScript.RangeAreas

getEntireRow()

Devolve um RangeAreas objeto que representa todas as linhas do RangeAreas (por exemplo, se a corrente RangeAreas representar as células "B4:E11", devolve uma RangeAreas que representa as linhas "4:11").

getEntireRow(): RangeAreas;

Retornos

ExcelScript.RangeAreas

getFormat()

Devolve um RangeFormat objeto, encapsulando o tipo de letra, o preenchimento, os limites, o alinhamento e outras propriedades para todos os intervalos no RangeAreas objeto.

getFormat(): RangeFormat;

Retornos

ExcelScript.RangeFormat

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

getIntersection(anotherRange)

Devolve o RangeAreas objeto que representa a interseção dos intervalos especificados ou RangeAreas. Se não for encontrada nenhuma interseção, este método devolve undefined.

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

Parâmetros

anotherRange: ExcelScript.Range | ExcelScript.RangeAreas | string

O intervalo, RangeAreas objeto ou endereço que será utilizado para determinar a interseção.

Retornos

ExcelScript.RangeAreas

getIsEntireColumn()

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

getIsEntireColumn(): boolean;

Retornos

boolean

getIsEntireRow()

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

getIsEntireRow(): boolean;

Retornos

boolean

getOffsetRangeAreas(rowOffset, columnOffset)

Devolve um RangeAreas objeto que é movido pelo desvio de linhas e colunas específico. A dimensão do devolvido RangeAreas corresponderá ao objeto original. Se o resultado RangeAreas for forçado fora dos limites da grelha da folha de cálculo, será gerado um erro.

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

Parâmetros

rowOffset: number

O número de linhas (positivo, negativo ou 0) pelo qual o RangeAreas deve ser compensado. Valores positivos estão deslocados para baixo, e os valores negativos para cima.

columnOffset: number

O número de colunas (positivo, negativo ou 0) pelo qual o RangeAreas é para ser compensado. Valores positivos estão deslocados para a direita, e os valores negativos para a esquerda.

Retornos

ExcelScript.RangeAreas

getPredefinedCellStyle()

Representa o estilo de todos os intervalos neste RangeAreas objeto. Se os estilos das células forem inconsistentes, null serão devolvidos. Para estilos personalizados, o nome do estilo será devolvido. Para estilos incorporados, será devolvida uma cadeia que representa um valor na BuiltInStyle enumeração.

getPredefinedCellStyle(): string;

Retornos

string

getSpecialCells(cellType, cellValueType)

Devolve um RangeAreas objeto que representa todas as células que correspondem ao tipo e valor especificados. Se não forem encontradas células especiais que correspondam aos critérios, este método devolve undefined.

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

Parâmetros

cellType: ExcelScript.SpecialCellType

O tipo de células a incluir.

cellValueType: ExcelScript.SpecialCellValueType

Se cellType for ou constantsformulas, este argumento é utilizado para determinar que tipos de células deve incluir no resultado. Estes valores podem ser combinados para devolver mais do que um tipo. O padrão é selecionar todas as constantes ou as fórmulas, independente do tipo.

Retornos

ExcelScript.RangeAreas

getTables(fullyContained)

Devolve uma coleção de tabelas no âmbito que se sobrepõem a qualquer intervalo neste RangeAreas objeto.

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

Parâmetros

fullyContained: boolean

Se true, devolve apenas as tabelas que estão totalmente contidas nos limites do intervalo. A predefinição é false.

Retornos

ExcelScript.Table[]

getUsedRangeAreas(valuesOnly)

Devolve o utilizado RangeAreas que compreende todas as áreas utilizadas de intervalos retangulares individuais no RangeAreas objeto. Se não existirem células utilizadas no RangeAreas, este método devolve undefined.

getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;

Parâmetros

valuesOnly: boolean

Se pretende considerar apenas células com valores como células utilizadas.

Retornos

ExcelScript.RangeAreas

getWorksheet()

Devolve a folha de cálculo do atual RangeAreas.

getWorksheet(): Worksheet;

Retornos

ExcelScript.Worksheet

setDirty()

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

setDirty(): void;

Retornos

void

setPredefinedCellStyle(predefinedCellStyle)

setPredefinedCellStyle(predefinedCellStyle: string): void;

Parâmetros

predefinedCellStyle: string

Retornos

void

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

Compartilhar via

ExcelScript.RangeAreas interface

Comentários

Exemplos

Métodos

Detalhes do método

addConditionalFormat(type)

Parâmetros

Retornos

calculate()

Retornos

clear(applyTo)

Parâmetros

Retornos

Exemplos

clearAllConditionalFormats()

Retornos

convertDataTypeToText()

Retornos

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Parâmetros

Retornos

getAddress()

Retornos

getAddressLocal()

Retornos

getAreaCount()

Retornos

getAreas()

Retornos

getCellCount()

Retornos

getConditionalFormat(id)

Parâmetros

Retornos

getConditionalFormats()

Retornos

getDataValidation()

Retornos

getEntireColumn()

Retornos

getEntireRow()

Retornos

getFormat()

Retornos

Exemplos

getIntersection(anotherRange)

Parâmetros

Retornos

getIsEntireColumn()

Retornos

getIsEntireRow()

Retornos

getOffsetRangeAreas(rowOffset, columnOffset)

Parâmetros

Retornos

getPredefinedCellStyle()

Retornos

getSpecialCells(cellType, cellValueType)

Parâmetros

Retornos

getTables(fullyContained)

Parâmetros

Retornos

getUsedRangeAreas(valuesOnly)

Parâmetros

Retornos

getWorksheet()

Retornos

setDirty()

Retornos

setPredefinedCellStyle(predefinedCellStyle)

Parâmetros

Retornos

Exemplos

Recursos adicionais