Excel.RangeAreas class

Referência

Pacote:: excel

RangeAreas representa uma coleção de um ou mais intervalos retangulares na mesma folha de cálculo. Para saber como utilizar intervalos descontínuos, leia Trabalhar com vários intervalos em simultâneo nos suplementos do Excel.

Extends: OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

address	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").
addressLocal	Devolve a `RangeAreas` referência na região do utilizador.
areaCount	Devolve o número de intervalos retangulares que compõem este `RangeAreas` objeto.
areas	Devolve uma coleção de intervalos retangulares que compõem este `RangeAreas` objeto.
cellCount	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).
conditionalFormats	Devolve uma coleção de formatos condicionais que se cruzam com quaisquer células neste `RangeAreas` objeto.
context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
dataValidation	Devolve um objeto de validação de dados para todos os intervalos no `RangeAreas`.
format	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.
isEntireColumn	Especifica se todos os intervalos neste `RangeAreas` objeto representam colunas inteiras (por exemplo, "A:C, Q:Z").
isEntireRow	Especifica se todos os intervalos neste `RangeAreas` objeto representam linhas inteiras (por exemplo, "1:3, 5:7").
style	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.
worksheet	Devolve a folha de cálculo do atual `RangeAreas`.

Métodos

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.
clear(applyToString)	Limpa valores, formato, preenchimento, limite e outras propriedades em cada uma das áreas que compõem este `RangeAreas` objeto.
clearOrResetContents()	Limpa os valores das células nos intervalos, tendo em consideração especial as células que contêm controlos. Se os intervalos contiverem apenas valores e controlos em branco definidos para o respetivo valor predefinido, os valores e a formatação de controlo serão removidos. Caso contrário, isto define as células com controlos para o valor predefinido e limpa os valores das outras células nos intervalos.
convertDataTypeToText()	Converte todas as células em `RangeAreas` com tipos de dados em texto.
convertToLinkedDataType(serviceID, languageCulture)	Converte todas as células nos `RangeAreas` tipos de dados ligados.
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, copyTypeString, 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.
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").
getIntersection(anotherRange)	Devolve o `RangeAreas` objeto que representa a interseção dos intervalos especificados ou `RangeAreas`. Se não for encontrada nenhuma interseção, será gerado um `ItemNotFound` erro.
getIntersectionOrNullObject(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 um objeto com a respetiva `isNullObject` propriedade definida como `true`. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
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.
getSpecialCells(cellType, cellValueType)	Devolve um `RangeAreas` objeto 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(cellTypeString, cellValueTypeString)	Devolve um `RangeAreas` objeto 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)	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 um objeto com a respetiva `isNullObject` propriedade definida como `true`. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)	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 um objeto com a respetiva `isNullObject` propriedade definida como `true`. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
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`, será gerado o `ItemNotFound` erro.
getUsedRangeAreasOrNullObject(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 um objeto com a respetiva `isNullObject` propriedade definida como `true`. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
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(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
setDirty()	Define o `RangeAreas` para ser recalculado quando ocorrer o próximo recálculo.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é transmitido para `JSON.stringify()`. (`JSON.stringify`por sua vez, chama o `toJSON` método do objeto que lhe é transmitido.) Enquanto o objeto original `Excel.RangeAreas` é um objeto de API, o `toJSON` método devolve um objeto JavaScript simples (escrito como `Excel.Interfaces.RangeAreasData`) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre `.sync` chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar `context.sync()` antes de a libertação da memória ser aplicada.

Detalhes da propriedade

address

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

readonly address: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

addressLocal

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

readonly addressLocal: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

areaCount

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

readonly areaCount: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

areas

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

readonly areas: Excel.RangeCollection;

Valor da propriedade

Excel.RangeCollection

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

cellCount

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

readonly cellCount: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

conditionalFormats

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

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Valor da propriedade

Excel.ConditionalFormatCollection

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

dataValidation

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

readonly dataValidation: Excel.DataValidation;

Valor da propriedade

Excel.DataValidation

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

format

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.

readonly format: Excel.RangeFormat;

Valor da propriedade

Excel.RangeFormat

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml

await Excel.run(async (context) => {

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

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

    await context.sync();
});

isEntireColumn

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

readonly isEntireColumn: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

isEntireRow

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

readonly isEntireRow: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

style

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.

style: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

worksheet

Devolve a folha de cálculo do atual RangeAreas.

readonly worksheet: Excel.Worksheet;

Valor da propriedade

Excel.Worksheet

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Detalhes do método

calculate()

Calcula todas as células no RangeAreas.

calculate(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

clear(applyTo)

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

clear(applyTo?: Excel.ClearApplyTo): void;

Parâmetros

applyTo: Excel.ClearApplyTo

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

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

clear(applyToString)

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

clear(applyToString?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;

Parâmetros

applyToString: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"

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

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

clearOrResetContents()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Limpa os valores das células nos intervalos, tendo em consideração especial as células que contêm controlos. Se os intervalos contiverem apenas valores e controlos em branco definidos para o respetivo valor predefinido, os valores e a formatação de controlo serão removidos. Caso contrário, isto define as células com controlos para o valor predefinido e limpa os valores das outras células nos intervalos.

clearOrResetContents(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

convertDataTypeToText()

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

convertDataTypeToText(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

convertToLinkedDataType(serviceID, languageCulture)

Converte todas as células nos RangeAreas tipos de dados ligados.

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

Parâmetros

serviceID: number

O ID do serviço que será utilizado para consultar os dados.

languageCulture: string

Cultura de idioma para consultar o serviço.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;

Parâmetros

sourceRange: Excel.Range | Excel.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: Excel.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

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

copyFrom(sourceRange: Range | RangeAreas | string, copyTypeString?: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths", skipBlanks?: boolean, transpose?: boolean): void;

Parâmetros

sourceRange: Excel.Range | Excel.RangeAreas | string

copyTypeString: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths"

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

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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(): Excel.RangeAreas;

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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(): Excel.RangeAreas;

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getIntersection(anotherRange)

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

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

Parâmetros

anotherRange: Excel.Range | Excel.RangeAreas | string

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

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getIntersectionOrNullObject(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 um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getIntersectionOrNullObject(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;

Parâmetros

anotherRange: Excel.Range | Excel.RangeAreas | string

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

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getSpecialCells(cellType, cellValueType)

Devolve um RangeAreas objeto 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: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Parâmetros

cellType: Excel.SpecialCellType

O tipo de células a incluir.

cellValueType: Excel.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

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getSpecialCells(cellTypeString, cellValueTypeString)

Devolve um RangeAreas objeto 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(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueTypeString?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Parâmetros

cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

O tipo de células a incluir.

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

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(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 um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Parâmetros

cellType: Excel.SpecialCellType

O tipo de células a incluir.

cellValueType: Excel.SpecialCellValueType

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)

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

Parâmetros

cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

O tipo de células a incluir.

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

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getTables(fullyContained)

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

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

Parâmetros

fullyContained: boolean

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

Retornos

Excel.TableScopedCollection

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getUsedRangeAreas(valuesOnly)

getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;

Parâmetros

valuesOnly: boolean

Se pretende considerar apenas células com valores como células utilizadas. A predefinição é false.

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getUsedRangeAreasOrNullObject(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 um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getUsedRangeAreasOrNullObject(valuesOnly?: boolean): Excel.RangeAreas;

Parâmetros

valuesOnly: boolean

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

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

load(options)

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

load(options?: Excel.Interfaces.RangeAreasLoadOptions): Excel.RangeAreas;

Parâmetros

options: Excel.Interfaces.RangeAreasLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.RangeAreas

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[]): Excel.RangeAreas;

Parâmetros

propertyNames: string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.RangeAreas

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.RangeAreas;

Parâmetros

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Excel.RangeAreas

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.RangeAreasUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties: Excel.Interfaces.RangeAreasUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options: OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Excel.RangeAreas): void;

Parâmetros

properties: Excel.RangeAreas

Retornos

void

setDirty()

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

setDirty(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.RangeAreas é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.RangeAreasData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.RangeAreasData;

Retornos

Excel.Interfaces.RangeAreasData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez.

track(): Excel.RangeAreas;

Retornos

Excel.RangeAreas

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Excel.RangeAreas;

Retornos

Excel.RangeAreas

Compartilhar via

Excel.RangeAreas class

Comentários

Propriedades

Métodos

Detalhes da propriedade

address

Valor da propriedade

Comentários

addressLocal

Valor da propriedade

Comentários

areaCount

Valor da propriedade

Comentários

areas

Valor da propriedade

Comentários

cellCount

Valor da propriedade

Comentários

conditionalFormats

Valor da propriedade

Comentários

context

Valor da propriedade

dataValidation

Valor da propriedade

Comentários

format

Valor da propriedade

Comentários

Exemplos

isEntireColumn

Valor da propriedade

Comentários

isEntireRow

Valor da propriedade

Comentários

style

Valor da propriedade

Comentários

worksheet

Valor da propriedade

Comentários

Detalhes do método

calculate()

Retornos

Comentários

clear(applyTo)

Parâmetros

Retornos

Comentários

clear(applyToString)

Parâmetros

Retornos

Comentários

clearOrResetContents()

Retornos

Comentários

convertDataTypeToText()

Retornos

Comentários

convertToLinkedDataType(serviceID, languageCulture)

Parâmetros

Retornos

Comentários

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Parâmetros

Retornos

Comentários

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

Parâmetros

Retornos

Comentários

getEntireColumn()

Retornos

Comentários

getEntireRow()

Retornos