Excel.RangeAreas class

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

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly addressLocal: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly areaCount: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly areas: Excel.RangeCollection;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

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

readonly dataValidation: Excel.DataValidation;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

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();
});

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

readonly isEntireColumn: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly isEntireRow: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Devolve a folha de cálculo do atual RangeAreas.

readonly worksheet: Excel.Worksheet;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Calcula todas as células no RangeAreas.

calculate(): void;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

convertDataTypeToText(): void;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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, copyTypeString?: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths", skipBlanks?: boolean, transpose?: boolean): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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: "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

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Retornos

Comentários

[ Conjunto de API: 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

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

Retornos

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

set(properties: Excel.RangeAreas): void;

Parâmetros

Retornos

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

setDirty(): void;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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 Excel.RangeAreas original é 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

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

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