ExcelScript.RangeAreas interface

RangeAreas representa uma coleção de um ou mais intervalos retangulares na mesma planilha.

Métodos

addConditionalFormat(type)

Adiciona um novo formato condicional à coleção na prioridade First/Top.

calculate()

Calcula todas as células no RangeAreas.

clear(applyTo)

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

clearAllConditionalFormats()

Limpa todos os formatos condicionais ativos no intervalo atual especificado.

convertDataTypeToText()

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

copyFrom(sourceRange, copyType, skipBlanks, transpose)

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

getAddress()

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

getAddressLocal()

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

getAreaCount()

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

getAreas()

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

getCellCount()

Retorna o número de células no objeto RangeAreas 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)

Retorna um formato condicional para o ID fornecido.

getConditionalFormats()

Retorna uma coleção de ConditionalFormats que se cruza com qualquer célula nesse objeto RangeAreas.

getDataValidation()

Retorna um objeto dataValidation para todos os intervalos no RangeAreas.

getEntireColumn()

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

getEntireRow()

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

getFormat()

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

getIntersection(anotherRange)

Retorna o objeto RangeAreas que representa a interseção dos intervalos fornecidos ou RangeAreas. Se nenhuma interseção for encontrada, um objeto null será retornado.

getIsEntireColumn()

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

getIsEntireRow()

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

getOffsetRangeAreas(rowOffset, columnOffset)

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

getPredefinedCellStyle()

Representa o estilo de todos os intervalos nesse objeto RangeAreas. Se os estilos das células forem inconsistentes, NULL será retornado. Para estilos personalizados, o nome do estilo será retornado. Para os estilos internos, uma cadeia de caracteres que representa um valor na enumeração BuiltInstyle será retornada.

getSpecialCells(cellType, cellValueType)

Retorna um objeto RangeAreas que representa todas as células que correspondem ao tipo e valor especificados. Retorna um objeto null se nenhuma célula especial que corresponda ao critério for encontrada.

getTables(fullyContained)

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

getUsedRangeAreas(valuesOnly)

Retorna o RangeAreas usado que compreende todas as áreas utilizadas de intervalos retangulares individuais no objeto RangeAreas. Se não houver células usadas no RangeAreas, um objeto NULL será retornado.

getWorksheet()

Retorna a planilha para o RangeAreas atual.

setDirty()

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

setPredefinedCellStyle(predefinedCellStyle)

Representa o estilo de todos os intervalos nesse objeto RangeAreas. Se os estilos das células forem inconsistentes, NULL será retornado. Para estilos personalizados, o nome do estilo será retornado. Para os estilos internos, uma cadeia de caracteres que representa um valor na enumeração BuiltInstyle será retornada.

Detalhes do método

addConditionalFormat(type)

Adiciona um novo formato condicional à coleção na prioridade First/Top.

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Parâmetros

type
ConditionalFormatType

O tipo de formato condicional que está sendo adicionado. Consulte ExcelScript. Valorconditionalformattype para obter detalhes.

Retornos

calculate()

Calcula todas as células no RangeAreas.

calculate(): void;

Retornos

void

clear(applyTo)

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

clear(applyTo?: ClearApplyTo): void;

Parâmetros

applyTo
ClearApplyTo

Opcional. Determina o tipo de ação clara. Consulte ExcelScript. ClearApplyTo para obter detalhes. O padrão é "All".

Retornos

void

clearAllConditionalFormats()

Limpa todos os formatos condicionais ativos no intervalo atual especificado.

clearAllConditionalFormats(): void;

Retornos

void

convertDataTypeToText()

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

convertDataTypeToText(): void;

Retornos

void

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copia a formatação ou dados da célula do intervalo de origem ou de RangeAreas para o RangeAreas atual. O rangeAreas de destino 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
Range | RangeAreas | string

O intervalo de origem ou RangeAreas a ser copiado. Quando o RangeAreas de origem tem vários intervalos, seu formulário deve ser criado removendo linhas ou colunas completas de um intervalo retangular.

copyType
RangeCopyType

O tipo de dados da célula ou formatação a ser copiada. O padrão é "All".

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 RangeAreas de destino. O padrão é false.

Retornos

void

getAddress()

Retorna a referência RangeAreas em estilo a1. O valor de 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

string

getAddressLocal()

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

getAddressLocal(): string;

Retornos

string

getAreaCount()

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

getAreaCount(): number;

Retornos

number

getAreas()

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

getAreas(): Range[];

Retornos

Range[]

getCellCount()

Retorna o número de células no objeto RangeAreas 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)

Retorna um formato condicional para o ID fornecido.

getConditionalFormat(id: string): ConditionalFormat;

Parâmetros

id
string

A ID da formatação condicional.

Retornos

getConditionalFormats()

Retorna uma coleção de ConditionalFormats que se cruza com qualquer célula nesse objeto RangeAreas.

getConditionalFormats(): ConditionalFormat[];

Retornos

getDataValidation()

Retorna um objeto dataValidation para todos os intervalos no RangeAreas.

getDataValidation(): DataValidation;

Retornos

getEntireColumn()

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

getEntireColumn(): RangeAreas;

Retornos

getEntireRow()

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

getEntireRow(): RangeAreas;

Retornos

getFormat()

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

getFormat(): RangeFormat;

Retornos

getIntersection(anotherRange)

Retorna o objeto RangeAreas que representa a interseção dos intervalos fornecidos ou RangeAreas. Se nenhuma interseção for encontrada, um objeto null será retornado.

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

Parâmetros

anotherRange
Range | RangeAreas | string

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

Retornos

getIsEntireColumn()

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

getIsEntireColumn(): boolean;

Retornos

boolean

getIsEntireRow()

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

getIsEntireRow(): boolean;

Retornos

boolean

getOffsetRangeAreas(rowOffset, columnOffset)

Retorna um objeto RangeAreas que é deslocado pelo deslocamento de linha e coluna específico. A dimensão do RangeAreas retornado corresponderá ao objeto original. Se o RangeAreas resultante for imposto para fora dos limites da grade da planilha, o sistema gerará 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 deslocado. 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 deve ser deslocado. Valores positivos estão deslocados para a direita, e os valores negativos para a esquerda.

Retornos

getPredefinedCellStyle()

Representa o estilo de todos os intervalos nesse objeto RangeAreas. Se os estilos das células forem inconsistentes, NULL será retornado. Para estilos personalizados, o nome do estilo será retornado. Para os estilos internos, uma cadeia de caracteres que representa um valor na enumeração BuiltInstyle será retornada.

getPredefinedCellStyle(): string;

Retornos

string

getSpecialCells(cellType, cellValueType)

Retorna um objeto RangeAreas que representa todas as células que correspondem ao tipo e valor especificados. Retorna um objeto null se nenhuma célula especial que corresponda ao critério for encontrada.

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

Parâmetros

cellType
SpecialCellType

O tipo de células a serem incluídas.

cellValueType
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 em conjunto 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 objeto RangeAreas.

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

Parâmetros

fullyContained
boolean

Se true, retornará somente as tabelas que estão totalmente contidas dentro dos limites do intervalo. O padrão é false.

Retornos

Table[]

getUsedRangeAreas(valuesOnly)

Retorna o RangeAreas usado que compreende todas as áreas utilizadas de intervalos retangulares individuais no objeto RangeAreas. Se não houver células usadas no RangeAreas, um objeto NULL será retornado.

getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;

Parâmetros

valuesOnly
boolean

Se deve apenas considerar as células com valores como células usadas.

Retornos

getWorksheet()

Retorna a planilha para o RangeAreas atual.

getWorksheet(): Worksheet;

Retornos

setDirty()

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

setDirty(): void;

Retornos

void

setPredefinedCellStyle(predefinedCellStyle)

Representa o estilo de todos os intervalos nesse objeto RangeAreas. Se os estilos das células forem inconsistentes, NULL será retornado. Para estilos personalizados, o nome do estilo será retornado. Para os estilos internos, uma cadeia de caracteres que representa um valor na enumeração BuiltInstyle será retornada.

setPredefinedCellStyle(predefinedCellStyle: string): void;

Parâmetros

predefinedCellStyle
string

Retornos

void