Excel.RangeAreas interface

RangeAreas representa uma coleção de um ou mais intervalos retangulares na mesma planilha. Para saber como usar intervalos do discontinguous, leia trabalhar com vários intervalos simultaneamente em suplementos do Excel.

Propriedades

address

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

addressLocal

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

areaCount

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

areas

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

cellCount

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).

conditionalFormats

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

dataValidation

Retorna um objeto dataValidation para todos os intervalos no RangeAreas.

format

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

isEntireColumn

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

isEntireRow

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

style

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.

worksheet

Retorna a planilha para o RangeAreas atual.

Métodos

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.

convertDataTypeToText()

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

convertToLinkedDataType(serviceID, languageCulture)

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

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.

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

getIntersection(anotherRange)

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

getIntersectionOrNullObject(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.

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.

getSpecialCells(cellType, cellValueType)

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

getSpecialCellsOrNullObject(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, o erro ItemNotFound será lançado.

getUsedRangeAreasOrNullObject(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.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

setDirty()

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

Detalhes da propriedade

address

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

readonly address: string;

Valor da propriedade

string

addressLocal

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

readonly addressLocal: string;

Valor da propriedade

string

areaCount

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

readonly areaCount: number;

Valor da propriedade

number

areas

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

readonly areas: RangeCollection;

Valor da propriedade

cellCount

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).

readonly cellCount: number;

Valor da propriedade

number

conditionalFormats

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

readonly conditionalFormats: ConditionalFormatCollection;

Valor da propriedade

dataValidation

Retorna um objeto dataValidation para todos os intervalos no RangeAreas.

readonly dataValidation: DataValidation;

Valor da propriedade

format

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

readonly format: RangeFormat;

Valor da propriedade

Exemplos

async function main(context: Excel.RequestContext) {

    let sheet = context.workbook.worksheets.getActiveWorksheet();
    let usedRange = sheet.getUsedRange();

    // Find the ranges with formulas.
    let formulaRanges = usedRange.getSpecialCells("Formulas");
    formulaRanges.format.fill.color = "lightgreen";

    await context.sync();
}

isEntireColumn

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

readonly isEntireColumn: boolean;

Valor da propriedade

boolean

isEntireRow

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

readonly isEntireRow: boolean;

Valor da propriedade

boolean

style

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.

style: string;

Valor da propriedade

string

worksheet

Retorna a planilha para o RangeAreas atual.

readonly worksheet: Worksheet;

Valor da propriedade

Detalhes do método

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
                | "All"
                | "Formats"
                | "Contents"
                | "Hyperlinks"
                | "RemoveHyperlinks"
        ): void;

Parâmetros

applyTo
| ClearApplyTo | "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"

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

Retornos

void

convertDataTypeToText()

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

convertDataTypeToText(): void;

Retornos

void

convertToLinkedDataType(serviceID, languageCulture)

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

convertToLinkedDataType(
            serviceID: number,
            languageCulture: string
        ): void;

Parâmetros

serviceID
number

A ID de serviço que será usada para consultar os dados.

languageCulture
string

Cultura de idioma para consultar o serviço.

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
                | "All"
                | "Formulas"
                | "Values"
                | "Formats",
            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 | "All" | "Formulas" | "Values" | "Formats"

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

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

getIntersection(anotherRange)

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

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

Parâmetros

anotherRange
Range | RangeAreas | string

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

Retornos

getIntersectionOrNullObject(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.

getIntersectionOrNullObject(
            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

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

getSpecialCells(cellType, cellValueType)

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

getSpecialCells(
            cellType:
                | SpecialCellType
                | "ConditionalFormats"
                | "DataValidations"
                | "Blanks"
                | "Constants"
                | "Formulas"
                | "SameConditionalFormat"
                | "SameDataValidation"
                | "Visible",
            cellValueType?:
                | SpecialCellValueType
                | "All"
                | "Errors"
                | "ErrorsLogical"
                | "ErrorsNumbers"
                | "ErrorsText"
                | "ErrorsLogicalNumber"
                | "ErrorsLogicalText"
                | "ErrorsNumberText"
                | "Logical"
                | "LogicalNumbers"
                | "LogicalText"
                | "LogicalNumbersText"
                | "Numbers"
                | "NumbersText"
                | "Text"
        ): RangeAreas;

Parâmetros

cellType
| SpecialCellType | "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

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

cellValueType
| SpecialCellValueType | "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

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

getSpecialCellsOrNullObject(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.

getSpecialCellsOrNullObject(
            cellType:
                | SpecialCellType
                | "ConditionalFormats"
                | "DataValidations"
                | "Blanks"
                | "Constants"
                | "Formulas"
                | "SameConditionalFormat"
                | "SameDataValidation"
                | "Visible",
            cellValueType?:
                | SpecialCellValueType
                | "All"
                | "Errors"
                | "ErrorsLogical"
                | "ErrorsNumbers"
                | "ErrorsText"
                | "ErrorsLogicalNumber"
                | "ErrorsLogicalText"
                | "ErrorsNumberText"
                | "Logical"
                | "LogicalNumbers"
                | "LogicalText"
                | "LogicalNumbersText"
                | "Numbers"
                | "NumbersText"
                | "Text"
        ): RangeAreas;

Parâmetros

cellType
| SpecialCellType | "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

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

cellValueType
| SpecialCellValueType | "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

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): TableScopedCollection;

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

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, o erro ItemNotFound será lançado.

getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;

Parâmetros

valuesOnly
boolean

Se deve apenas considerar as células com valores como células usadas. O padrão é false.

Retornos

getUsedRangeAreasOrNullObject(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.

getUsedRangeAreasOrNullObject(valuesOnly?: boolean): RangeAreas;

Parâmetros

valuesOnly
boolean

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

Retornos

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void

setDirty()

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

setDirty(): void;

Retornos

void