Excel.RangeAreas class
RangeAreas representa uma coleção de um ou mais intervalos retangulares na mesma planilha. Para saber como usar intervalos descoloridos, leia Trabalhar com vários intervalos simultaneamente em suplementos do Excel.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.9 ]
Propriedades
| address | Retorna a |
| address |
Retorna a |
| area |
Retorna o número de intervalos retangulares que compõem esse |
| areas | Retorna uma coleção de intervalos retangulares que compõem esse |
| cell |
Retorna o número de células no |
| conditional |
Retorna uma coleção de formatos condicionais que se cruzam com todas as células deste |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| data |
Retorna um objeto de validação de dados para todos os intervalos no |
| format | Retorna um |
| is |
Especifica se todos os intervalos neste |
| is |
Especifica se todos os intervalos neste |
| style | Representa o estilo para todos os intervalos neste |
| worksheet | Retorna a planilha para o atual |
Métodos
| 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(apply |
Limpa valores, formato, preenchimento, borda e outras propriedades em cada uma das áreas que compõem esse |
| convert |
Converte todas as células no |
| convert |
Converte todas as células no em |
| copy |
Copia dados de célula ou formatação do intervalo de origem ou |
| copy |
Copia dados de célula ou formatação do intervalo de origem ou |
| get |
Retorna um |
| get |
Retorna um |
| get |
Retorna o |
| get |
Retorna o |
| get |
Retorna um |
| get |
Retorna um |
| get |
Retorna um |
| get |
Retorna um |
| 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 o usado |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| set |
Define o |
| toJSON() | Substitui o método JavaScript |
| track() | Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre |
| untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar |
Detalhes da propriedade
address
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").
readonly address: string;Valor da propriedade
string
Comentários
addressLocal
Retorna a RangeAreas referência na localidade do usuário.
readonly addressLocal: string;Valor da propriedade
string
Comentários
areaCount
Retorna o número de intervalos retangulares que compõem esse RangeAreas objeto.
readonly areaCount: number;Valor da propriedade
number
Comentários
areas
Retorna uma coleção de intervalos retangulares que compõem esse RangeAreas objeto.
readonly areas: Excel.RangeCollection;Valor da propriedade
Comentários
cellCount
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).
readonly cellCount: number;Valor da propriedade
number
Comentários
conditionalFormats
Retorna uma coleção de formatos condicionais que se cruzam com todas as células deste RangeAreas objeto.
readonly conditionalFormats: Excel.ConditionalFormatCollection;Valor da propriedade
Comentários
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
dataValidation
Retorna um objeto de validação de dados para todos os intervalos no RangeAreas.
readonly dataValidation: Excel.DataValidation;Valor da propriedade
Comentários
format
Retorna um RangeFormat objeto, encapsulando a fonte, preenchimento, bordas, alinhamento e outras propriedades para todos os intervalos no RangeAreas objeto.
readonly format: Excel.RangeFormat;Valor da propriedade
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
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
style
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.
style: string;Valor da propriedade
string
Comentários
worksheet
Retorna a planilha para o atual RangeAreas.
readonly worksheet: Excel.Worksheet;Valor da propriedade
Comentários
Detalhes do método
calculate()
Calcula todas as células no RangeAreas.
calculate(): void;Retornos
void
Comentários
clear(applyTo)
Limpa valores, formato, preenchimento, borda e outras propriedades em cada uma das áreas que compõem esse RangeAreas objeto.
clear(applyTo?: Excel.ClearApplyTo): void;Parâmetros
- applyTo
- Excel.ClearApplyTo
Opcional. Determina o tipo de ação clara. Confira Excel.ClearApplyTo detalhes. O padrão é "Todos".
Retornos
void
Comentários
clear(applyToString)
Limpa valores, formato, preenchimento, borda e outras propriedades em cada uma das áreas que compõem esse RangeAreas objeto.
clear(applyToString?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"): void;Parâmetros
- applyToString
-
"All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"
Opcional. Determina o tipo de ação clara. Confira Excel.ClearApplyTo detalhes. O padrão é "Todos".
Retornos
void
Comentários
convertDataTypeToText()
Converte todas as células no RangeAreas com tipos de dados em texto.
convertDataTypeToText(): void;Retornos
void
Comentários
convertToLinkedDataType(serviceID, languageCulture)
Converte todas as células no em RangeAreas tipos de dados vinculados.
convertToLinkedDataType(serviceID: number, languageCulture: string): void;Parâmetros
- serviceID
-
number
A ID do serviço que será usada para consultar os dados.
- languageCulture
-
string
Cultura de idioma para consultar o serviço.
Retornos
void
Comentários
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?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;Parâmetros
- sourceRange
-
Excel.Range | Excel.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
- Excel.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
Comentários
copyFrom(sourceRange, copyTypeString, 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, copyTypeString?: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths", skipBlanks?: boolean, transpose?: boolean): void;Parâmetros
- sourceRange
-
Excel.Range | Excel.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.
- copyTypeString
-
"All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths"
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
Comentários
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(): Excel.RangeAreas;Retornos
Comentários
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(): Excel.RangeAreas;Retornos
Comentários
getIntersection(anotherRange)
Retorna o RangeAreas objeto que representa a interseção dos intervalos determinados ou RangeAreas. Se nenhuma interseção for encontrada, um ItemNotFound erro será gerado.
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á usado para determinar a interseção.
Retornos
Comentários
getIntersectionOrNullObject(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á um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades 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á usado para determinar a interseção.
Retornos
Comentários
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): Excel.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
Comentários
getSpecialCells(cellType, cellValueType)
Retorna 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 serem incluídas.
- cellValueType
- Excel.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
Comentários
getSpecialCells(cellTypeString, cellValueTypeString)
Retorna 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 serem incluídas.
- cellValueTypeString
-
"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 para retornar mais de um tipo. O padrão é selecionar todas as constantes ou as fórmulas, independente do tipo.
Retornos
Comentários
getSpecialCellsOrNullObject(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á um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;Parâmetros
- cellType
- Excel.SpecialCellType
O tipo de células a serem incluídas.
- cellValueType
- Excel.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
Comentários
getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)
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á um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
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 serem incluídas.
- cellValueTypeString
-
"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 para retornar mais de um tipo. O padrão é selecionar todas as constantes ou as fórmulas, independente do tipo.
Retornos
Comentários
getTables(fullyContained)
Retorna uma coleção de tabelas com escopo que se sobrepõe a qualquer intervalo neste RangeAreas objeto.
getTables(fullyContained?: boolean): Excel.TableScopedCollection;Parâmetros
- fullyContained
-
boolean
Se true, retornará apenas tabelas totalmente contidas nos limites de intervalo. O padrão é false.
Retornos
Comentários
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, o ItemNotFound erro será gerado.
getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;Parâmetros
- valuesOnly
-
boolean
Se deve considerar apenas células com valores como células usadas. O padrão é false.
Retornos
Comentários
getUsedRangeAreasOrNullObject(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á um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getUsedRangeAreasOrNullObject(valuesOnly?: boolean): Excel.RangeAreas;Parâmetros
- valuesOnly
-
boolean
Se deve considerar apenas células com valores como células usadas.
Retornos
Comentários
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
Fornece opções para quais propriedades do objeto carregar.
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[]): Excel.RangeAreas;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas 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 estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
set(properties: Excel.RangeAreas): void;Parâmetros
- properties
- Excel.RangeAreas
Retornos
void
setDirty()
Define o RangeAreas a ser recalculado quando ocorrer o próximo recálculo.
setDirty(): void;Retornos
void
Comentários
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.RangeAreas original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.RangeAreasData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.RangeAreasData;Retornos
track()
Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse 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, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez.
track(): Excel.RangeAreas;Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar context.sync() antes que a versão da memória entre em vigor.
untrack(): Excel.RangeAreas;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de