Excel.WorkbookRangeAreas class

Pacote:

excel

Representa uma coleção de um ou mais intervalos retangulares em várias planilhas.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

Propriedades

addresses	Retorna uma matriz de endereços no estilo A1. Os valores de endereço contêm o nome da planilha para cada bloco retangular de células (por exemplo, "Sheet1! A1:B4, Sheet1! D1:D4"). Somente leitura.
areas	Retorna o RangeAreasCollection objeto. Cada RangeAreas um na coleção representa um ou mais intervalos de retângulo em uma planilha.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
ranges	Retorna intervalos que compõem esse objeto em um RangeCollection objeto.

Métodos

getRangeAreasBySheet(key)	Retorna o RangeAreas objeto com base na ID da planilha ou no nome da coleção.
getRangeAreasOrNullObjectBySheet(key)	Retorna o RangeAreas objeto com base no nome da planilha ou na ID da coleção. Se a planilha não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades 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.
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.WorkbookRangeAreas original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorkbookRangeAreasData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
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.
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.

Detalhes da propriedade

addresses

Retorna uma matriz de endereços no estilo A1. Os valores de endereço contêm o nome da planilha para cada bloco retangular de células (por exemplo, "Sheet1! A1:B4, Sheet1! D1:D4"). Somente leitura.

readonly addresses: string[];

Valor da propriedade

string[]

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

areas

Retorna o RangeAreasCollection objeto. Cada RangeAreas um na coleção representa um ou mais intervalos de retângulo em uma planilha.

readonly areas: Excel.RangeAreasCollection;

Valor da propriedade

Excel.RangeAreasCollection

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

Exemplos

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

await Excel.run(async (context) => {
  // Precedents are cells referenced by the formula in a cell.
  // A "direct precedent" is a cell directly referenced by the selected formula.
  let range = context.workbook.getActiveCell();
  let directPrecedents = range.getDirectPrecedents();
  range.load("address");
  directPrecedents.areas.load("address");
  await context.sync();

  console.log(`Direct precedent cells of ${range.address}:`);

  // Use the direct precedents API to loop through precedents of the active cell.
  for (let i = 0; i < directPrecedents.areas.items.length; i++) {
    // Highlight and console the address of each precedent cell.
    directPrecedents.areas.items[i].format.fill.color = "Yellow";
    console.log(`  ${directPrecedents.areas.items[i].address}`);
  }
  await context.sync();
});

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

Excel.RequestContext

ranges

Retorna intervalos que compõem esse objeto em um RangeCollection objeto.

readonly ranges: Excel.RangeCollection;

Valor da propriedade

Excel.RangeCollection

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

Detalhes do método

getRangeAreasBySheet(key)

Retorna o RangeAreas objeto com base na ID da planilha ou no nome da coleção.

getRangeAreasBySheet(key: string): Excel.RangeAreas;

Parâmetros

key

string

O nome ou ID da planilha.

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

getRangeAreasOrNullObjectBySheet(key)

Retorna o RangeAreas objeto com base no nome da planilha ou na ID da coleção. Se a planilha não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

getRangeAreasOrNullObjectBySheet(key: string): Excel.RangeAreas;

Parâmetros

key

string

O nome ou ID da planilha.

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

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

Parâmetros

options

Excel.Interfaces.WorkbookRangeAreasLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.WorkbookRangeAreas

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.WorkbookRangeAreas;

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

Excel.WorkbookRangeAreas

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.WorkbookRangeAreas;

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

Excel.WorkbookRangeAreas

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.WorkbookRangeAreas original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorkbookRangeAreasData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.WorkbookRangeAreasData;

Retornos

Excel.Interfaces.WorkbookRangeAreasData

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.WorkbookRangeAreas;

Retornos

Excel.WorkbookRangeAreas

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.WorkbookRangeAreas;

Retornos

Excel.WorkbookRangeAreas