Excel.RangeAreas class

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, "Planilha1! A1:B4, Planilha1! D1:D4").

readonly address: string;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

readonly addressLocal: string;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

readonly areaCount: number;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

readonly areas: Excel.RangeCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

Retorna 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

Comentários

[Conjunto de apis: ExcelApi 1.9]

Retorna uma coleção de formatos condicionais que se cruzam com qualquer célula nesse RangeAreas objeto.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

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

readonly dataValidation: Excel.DataValidation;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

readonly format: Excel.RangeFormat;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

readonly isEntireColumn: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

readonly isEntireRow: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

style: string;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

Retorna a planilha para o arquivo .RangeAreas

readonly worksheet: Excel.Worksheet;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

Calcula todas as células no campo RangeAreas.

calculate(): void;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

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

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

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

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

Limpa os valores das células nos intervalos, com consideração especial para as células que contêm controles. Se os intervalos contiverem apenas valores em branco e controles definidos com seu valor padrão, os valores e a formatação de controle serão removidos. Caso contrário, isso definirá as células com controles para seu valor padrão e limpará os valores das outras células nos intervalos.

clearOrResetContents(): void;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.18]

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

convertDataTypeToText(): void;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

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

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

Copia os dados da célula ou a formatação do intervalo de origem ou RangeAreas para o arquivo .RangeAreas O destino RangeAreas pode ter 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

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

Copia os dados da célula ou a formatação do intervalo de origem ou RangeAreas para o arquivo .RangeAreas O destino RangeAreas pode ter 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?: "All" | "Formulas" | "Values" | "Formats" | "Link", skipBlanks?: boolean, transpose?: boolean): void;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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 que representa as RangeAreas colunas "B:E, H:H").

getEntireColumn(): Excel.RangeAreas;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

getEntireRow(): Excel.RangeAreas;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

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

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

Retorna o RangeAreas objeto que representa a interseção dos intervalos fornecidos 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

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

getOffsetRangeAreas(rowOffset: number, columnOffset: number): Excel.RangeAreas;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

Retorna 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, 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

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

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

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

Retorna o usado RangeAreas que compreende todas as áreas usadas de intervalos retangulares individuais no RangeAreas objeto. Se não houver células usadas dentro do RangeAreas, o ItemNotFound erro será gerado.

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

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

Retorna o usado RangeAreas que compreende todas as áreas usadas de intervalos retangulares individuais no RangeAreas objeto. Se não houver células usadas dentro do 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

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

Retornos

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

Retornos

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

Retornos

Seleciona as áreas de intervalo especificadas na interface do usuário do Excel.

select(): void;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.18]

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

Retornos

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

set(properties: Excel.RangeAreas): void;

Parâmetros

Retornos

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

setDirty(): void;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.RangeAreas é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.RangeAreasData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.RangeAreasData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de 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, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez.

track(): Excel.RangeAreas;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de 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á ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Excel.RangeAreas;

Retornos