ExcelScript.RangeAreas interface
RangeAreas
representa uma coleção de um ou mais intervalos retangulares na mesma planilha.
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
add |
Adiciona um novo formato condicional à coleção na prioridade de primeira/superior. |
calculate() | Calcula todas as células no |
clear(apply |
Limpa valores, formato, preenchimento, borda e outras propriedades em cada uma das áreas que compõem esse |
clear |
Limpa todos os formatos condicionais ativos no intervalo atual especificado. |
convert |
Converte todas as células no |
copy |
Copia dados de célula ou formatação do intervalo de origem ou |
get |
Retorna a |
get |
Retorna a |
get |
Retorna o número de intervalos retangulares que compõem esse |
get |
Retorna uma coleção de intervalos retangulares que compõem esse |
get |
Retorna o número de células no |
get |
Retorna um formato condicional identificado por sua ID. Se o objeto de formato condicional não existir, esse método retornará |
get |
Retorna uma coleção de formatos condicionais que se cruzam com todas as células deste |
get |
Retorna um objeto de validação de dados para todos os intervalos no |
get |
Retorna um |
get |
Retorna um |
get |
Retorna um |
get |
Retorna o |
get |
Especifica se todos os intervalos neste |
get |
Especifica se todos os intervalos neste |
get |
Retorna um |
get |
Representa o estilo para todos os intervalos neste |
get |
Retorna um |
get |
Retorna uma coleção de tabelas com escopo que se sobrepõe a qualquer intervalo neste |
get |
Retorna o usado |
get |
Retorna a planilha para o atual |
set |
Define o |
set |
Representa o estilo para todos os intervalos neste |
Detalhes do método
addConditionalFormat(type)
Adiciona um novo formato condicional à coleção na prioridade de primeira/superior.
addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;
Parâmetros
O tipo de formato condicional que está sendo adicionado. Confira ExcelScript.ConditionalFormatType
detalhes.
Retornos
calculate()
Calcula todas as células no RangeAreas
.
calculate(): void;
Retornos
void
clear(applyTo)
Limpa valores, formato, preenchimento, borda e outras propriedades em cada uma das áreas que compõem esse RangeAreas
objeto.
clear(applyTo?: ClearApplyTo): void;
Parâmetros
- applyTo
- ExcelScript.ClearApplyTo
Opcional. Determina o tipo de ação clara. Confira ExcelScript.ClearApplyTo
detalhes. O padrão é "Todos".
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 no RangeAreas
com tipos de dados em texto.
convertDataTypeToText(): void;
Retornos
void
copyFrom(sourceRange, copyType, skipBlanks, transpose)
Copia dados de célula ou formatação do intervalo de origem ou RangeAreas
para o atual RangeAreas
. O destino RangeAreas
pode ser 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
- sourceRange
-
ExcelScript.Range | ExcelScript.RangeAreas | string
O intervalo de origem ou RangeAreas
para copiar. Quando a origem RangeAreas
tem vários intervalos, seu formulário deve ser capaz de ser criado removendo linhas ou colunas completas de um intervalo retangular.
- copyType
- ExcelScript.RangeCopyType
O tipo de dados de célula ou formatação a ser copiado. O padrão é "Todos".
- skipBlanks
-
boolean
True se para ignorar células em branco no intervalo de origem ou RangeAreas
. O padrão é false.
- transpose
-
boolean
True se para transpor as células no destino RangeAreas
. O padrão é false.
Retornos
void
getAddress()
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, "Sheet1! A1:B4, Sheet1! D1:D4").
getAddress(): string;
Retornos
string
getAddressLocal()
Retorna a RangeAreas
referência na localidade do usuário.
getAddressLocal(): string;
Retornos
string
getAreaCount()
Retorna o número de intervalos retangulares que compõem esse RangeAreas
objeto.
getAreaCount(): number;
Retornos
number
getAreas()
Retorna uma coleção de intervalos retangulares que compõem esse RangeAreas
objeto.
getAreas(): Range[];
Retornos
getCellCount()
Retorna o número de células no RangeAreas
objeto, resumindo 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)
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
- id
-
string
A ID do formato condicional.
Retornos
ExcelScript.ConditionalFormat | undefined
getConditionalFormats()
Retorna uma coleção de formatos condicionais que se cruzam com todas as células deste RangeAreas
objeto.
getConditionalFormats(): ConditionalFormat[];
Retornos
getDataValidation()
Retorna um objeto de validação de dados para todos os intervalos no RangeAreas
.
getDataValidation(): DataValidation;
Retornos
getEntireColumn()
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 RangeAreas
que representa colunas "B:E, H:H").
getEntireColumn(): RangeAreas;
Retornos
getEntireRow()
Retorna um RangeAreas
objeto que representa as linhas inteiras do RangeAreas
(por exemplo, se o atual RangeAreas
representa as células "B4:E11", ele retorna um RangeAreas
que representa linhas "4:11").
getEntireRow(): RangeAreas;
Retornos
getFormat()
Retorna um RangeFormat
objeto, encapsulando a fonte, preenchimento, bordas, 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");
}
getIntersection(anotherRange)
Retorna o RangeAreas
objeto que representa a interseção dos intervalos determinados ou RangeAreas
. Se nenhuma interseção for encontrada, esse método retornará undefined
.
getIntersection(anotherRange: Range | RangeAreas | string): RangeAreas;
Parâmetros
- anotherRange
-
ExcelScript.Range | ExcelScript.RangeAreas | string
O intervalo, RangeAreas
objeto ou endereço que será usado para determinar a interseção.
Retornos
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)
Retorna um RangeAreas
objeto que é deslocado pela linha específica e deslocamento de coluna. A dimensão do retornado RangeAreas
corresponderá ao objeto original. Se o resultado RangeAreas
for forçado fora dos limites da grade da planilha, um erro será gerado.
getOffsetRangeAreas(
rowOffset: number,
columnOffset: number
): RangeAreas;
Parâmetros
- rowOffset
-
number
O número de linhas (positivas, negativas ou 0) pelas quais 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 (positivas, negativas ou 0) pelas quais o RangeAreas
deve ser compensado. Valores positivos estão deslocados para a direita, e os valores negativos para a esquerda.
Retornos
getPredefinedCellStyle()
Representa o estilo para todos os intervalos neste RangeAreas
objeto. Se os estilos das células forem inconsistentes, null
serão retornados. Para estilos personalizados, o nome do estilo será retornado. Para estilos internos, uma cadeia de caracteres que representa um valor no BuiltInStyle
enum será retornada.
getPredefinedCellStyle(): string;
Retornos
string
getSpecialCells(cellType, cellValueType)
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
- cellType
- ExcelScript.SpecialCellType
O tipo de células a serem incluídas.
- cellValueType
- ExcelScript.SpecialCellValueType
Se cellType
for constants
ou formulas
, esse argumento será usado para determinar quais tipos de células incluir no resultado. Esses valores podem ser combinados para retornar mais de um tipo. O padrão é selecionar todas as constantes ou as fórmulas, independente do tipo.
Retornos
getTables(fullyContained)
Retorna uma coleção de tabelas com escopo que se sobrepõe a qualquer intervalo neste RangeAreas
objeto.
getTables(fullyContained?: boolean): Table[];
Parâmetros
- fullyContained
-
boolean
Se true
, retornará apenas tabelas totalmente contidas nos limites de intervalo. O padrão é false
.
Retornos
getUsedRangeAreas(valuesOnly)
Retorna o usado RangeAreas
que compreende todas as áreas usadas de intervalos retangulares individuais no RangeAreas
objeto. Se não houver células usadas no RangeAreas
, esse método retornará undefined
.
getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;
Parâmetros
- valuesOnly
-
boolean
Se deve considerar apenas células com valores como células usadas.
Retornos
getWorksheet()
Retorna a planilha para o atual RangeAreas
.
getWorksheet(): Worksheet;
Retornos
setDirty()
Define o RangeAreas
a ser recalculado quando ocorrer o próximo recálculo.
setDirty(): void;
Retornos
void
setPredefinedCellStyle(predefinedCellStyle)
Representa o estilo para todos os intervalos neste RangeAreas
objeto. Se os estilos das células forem inconsistentes, null
serão retornados. Para estilos personalizados, o nome do estilo será retornado. Para estilos internos, uma cadeia de caracteres que representa um valor no BuiltInStyle
enum será retornada.
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.");
}
}