Excel.WorkbookRangeAreas class
Representa uma coleção de um ou mais intervalos retangulares em várias folhas de cálculo.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.12 ]
Propriedades
| addresses | Devolve uma matriz de endereços no estilo A1. Os valores de endereço contêm o nome da folha de cálculo para cada bloco retangular de células (por exemplo, "Folha1! A1:B4, Folha1! D1:D4"). Somente leitura. |
| areas | Devolve o |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| ranges | Devolve intervalos que compõem este objeto num |
Métodos
| get |
Devolve o |
| get |
Devolve o |
| 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 |
| toJSON() | Substitui o método JavaScript |
| 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 |
| 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 |
Detalhes da propriedade
addresses
Devolve uma matriz de endereços no estilo A1. Os valores de endereço contêm o nome da folha de cálculo para cada bloco retangular de células (por exemplo, "Folha1! A1:B4, Folha1! D1:D4"). Somente leitura.
readonly addresses: string[];Valor da propriedade
string[]
Comentários
areas
Devolve o RangeAreasCollection objeto . Cada RangeAreas um na coleção representa um ou mais intervalos de retângulos numa folha de cálculo.
readonly areas: Excel.RangeAreasCollection;Valor da propriedade
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 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
ranges
Devolve intervalos que compõem este objeto num RangeCollection objeto.
readonly ranges: Excel.RangeCollection;Valor da propriedade
Comentários
Detalhes do método
getRangeAreasBySheet(key)
Devolve o RangeAreas objeto com base no ID ou nome da folha de cálculo na coleção.
getRangeAreasBySheet(key: string): Excel.RangeAreas;Parâmetros
- key
-
string
O nome ou ID da folha de cálculo.
Retornos
Comentários
getRangeAreasOrNullObjectBySheet(key)
Devolve o RangeAreas objeto com base no nome ou ID da folha de cálculo na coleção. Se a folha de cálculo não existir, 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).
getRangeAreasOrNullObjectBySheet(key: string): Excel.RangeAreas;Parâmetros
- key
-
string
O nome ou ID da folha de cálculo.
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.WorkbookRangeAreasLoadOptions): Excel.WorkbookRangeAreas;Parâmetros
Fornece opções para as propriedades do objeto a 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.WorkbookRangeAreas;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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.WorkbookRangeAreas;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
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.WorkbookRangeAreas é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WorkbookRangeAreasData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.WorkbookRangeAreasData;Retornos
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.WorkbookRangeAreas;Retornos
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.WorkbookRangeAreas;