Excel. Worksheet class

Propriedades

autoFilter	Representa o `AutoFilter` objeto da planilha.
charts	Retorna uma coleção de gráficos que fazem parte da planilha.
comments	Retorna um conjunto de todos os objetos Comments na planilha.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
customProperties	Obtém uma coleção de propriedades personalizadas no nível da planilha.
enableCalculation	Determina se o Excel deve recalcular a planilha quando necessário. True se o Excel recalcular a planilha quando necessário. False se o Excel não recalcular a planilha.
freezePanes	Obtém um objeto que pode ser usado para manipular painéis congelados na planilha.
horizontalPageBreaks	Obtém a coleção de quebra de página horizontal da planilha. Esta coleção contém apenas quebras de página manuais.
id	Retorna um valor que identifica de forma exclusiva a planilha em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a planilha seja renomeada ou movida.
name	O nome de exibição da planilha.
namedSheetViews	Retorna uma coleção de exibições de planilha que estão presentes na planilha.
names	Coleção de nomes com escopo para a planilha atual.
pageLayout	Obtém o `PageLayout` objeto da planilha.
pivotTables	Coleção de Tabelas Dinâmicas que fazem parte da planilha.
position	A posição baseada em zero da planilha na pasta de trabalho.
protection	Retorna o objeto de proteção de planilha para uma planilha.
shapes	Retorna a coleção de todos os objetos Shape na planilha.
showGridlines	Especifica se as linhas de grade estão visíveis para o usuário.
showHeadings	Especifica se os títulos estão visíveis para o usuário.
slicers	Retorna uma coleção de segmentações que fazem parte da planilha.
standardHeight	Retorna a altura padrão de todas as linhas na planilha, em pontos.
standardWidth	Especifica a largura padrão (padrão) de todas as colunas na planilha. Uma unidade de largura de coluna equivale à largura de um caractere no estilo Normal. Para fontes proporcionais, será usada a largura do caractere 0 (zero).
tabColor	A cor da guia da planilha. Ao recuperar a cor da guia, se a planilha estiver invisível, o valor será `null`. Se a planilha estiver visível, mas a cor da guia estiver definida como automática, uma cadeia de caracteres vazia será retornada. Caso contrário, a propriedade será definida como uma cor, no formulário #RRGGBB (por exemplo, "FFA500"). Ao definir a cor, use uma cadeia de caracteres vazia para definir uma cor "automática" ou uma cor real caso contrário.
tabId	Retorna um valor que representa essa planilha que pode ser lido pelo Open Office XML. Esse é um valor inteiro, que é diferente de `worksheet.id` (que retorna um identificador globalmente exclusivo) e `worksheet.name` (que retorna um valor como "Sheet1").
tables	Coleção de tabelas que fazem parte da planilha.
tasks	Retorna uma coleção de tarefas presentes na planilha.
verticalPageBreaks	Obtém a coleção de quebra de página vertical da planilha. Esta coleção contém apenas quebras de página manuais.
visibility	A visibilidade da planilha.

Métodos

activate()	Ative a planilha na interface do usuário do Excel.
calculate(markAllDirty)	Calcula todas as células em uma planilha.
copy(positionType, relativeTo)	Copia uma planilha e a coloca na posição especificada.
copy(positionTypeString, relativeTo)	Copia uma planilha e a coloca na posição especificada.
delete()	Exclui a planilha da pasta de trabalho. Observe que, se a visibilidade da planilha estiver definida como "VeryHidden", a operação de exclusão falhará com uma exceção `InvalidOperation` . Primeiro, você deve alterar sua visibilidade para oculta ou visível antes de excluí-la.
findAll(text, criteria)	Localiza todas as ocorrências da cadeia de caracteres determinada com base nos critérios especificados e as retorna como um `RangeAreas` objeto, compreendendo um ou mais intervalos retangulares.
findAllOrNullObject(text, criteria)	Localiza todas as ocorrências da cadeia de caracteres determinada com base nos critérios especificados e as retorna como um `RangeAreas` objeto, compreendendo um ou mais intervalos retangulares.
getCell(row, column)	Obtém o `Range` objeto que contém a célula única com base em números de linha e coluna. A célula pode estar fora dos limites de seu intervalo pai, desde que permaneça dentro da grade da planilha.
getNext(visibleOnly)	Obtém a planilha que segue esta. Se não houver planilhas seguindo esta, esse método gerará um erro.
getNextOrNullObject(visibleOnly)	Obtém a planilha que segue esta. Se não houver planilhas seguindo esta, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getPrevious(visibleOnly)	Obtém a planilha que precede essa. Se não houver planilhas anteriores, esse método gerará um erro.
getPreviousOrNullObject(visibleOnly)	Obtém a planilha que precede essa. Se não houver planilhas anteriores, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getRange(address)	Obtém o `Range` objeto, representando um único bloco retangular de células, especificado pelo endereço ou nome.
getRangeByIndexes(startRow, startColumn, rowCount, columnCount)	Obtém o `Range` objeto começando em um índice de linha específico e índice de coluna e abrangendo um determinado número de linhas e colunas.
getRanges(address)	Obtém o `RangeAreas` objeto, que representa um ou mais blocos de intervalos retangulares, especificados pelo endereço ou nome.
getUsedRange(valuesOnly)	O intervalo usado é o menor intervalo que abrange todas as células que têm um valor ou uma formatação atribuída a elas. Se toda a planilha estiver em branco, essa função retornará a célula superior esquerda (ou seja, não gerará um erro).
getUsedRangeOrNullObject(valuesOnly)	O intervalo usado é o menor intervalo que abrange todas as células que têm um valor ou uma formatação atribuída a elas. Se toda a planilha estiver em branco, 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.
replaceAll(text, replacement, criteria)	Localiza e substitui a cadeia de caracteres fornecida com base nos critérios especificados na planilha atual.
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.
showOutlineLevels(rowLevels, columnLevels)	Mostra grupos de linhas ou colunas pelos níveis de contorno. Descreve grupos e resume uma lista de dados na planilha. Os `rowLevels` parâmetros e `columnLevels` especificam quantos níveis do contorno serão exibidos. O intervalo de argumentos aceitável está entre 0 e 8. Um valor de 0 não altera a exibição atual. Um valor maior que o número atual de níveis exibe todos os níveis.
toJSON()	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 Excel.Worksheet original é um objeto API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Excel.Interfaces.WorksheetData`) que contém cópias rasas de todas as propriedades filho carregadas do objeto original.

Eventos

onActivated	Ocorre quando a planilha é ativada.
onCalculated	Ocorre quando a planilha é calculada.
onChanged	Ocorre quando os dados são alterados em uma planilha específica.
onColumnSorted	Ocorre quando uma ou mais colunas são classificadas. Isso acontece como resultado de uma operação de classificação da esquerda para a direita.
onDeactivated	Ocorre quando a planilha é desativada.
onFiltered	Ocorre quando um filtro é aplicado em uma planilha específica.
onFormatChanged	Ocorre quando o formato é alterado em uma planilha específica.
onFormulaChanged	Ocorre quando uma ou mais fórmulas são alteradas nesta planilha. Esse evento é para quando a fórmula em si é alterada, não o valor de dados resultante do cálculo da fórmula.
onNameChanged	Ocorre quando o nome da planilha é alterado.
onProtectionChanged	Ocorre quando o estado de proteção de planilha é alterado.
onRowHiddenChanged	Ocorre quando o estado oculto de uma ou mais linhas é alterado em uma planilha específica.
onRowSorted	Ocorre quando uma ou mais linhas são classificadas. Isso ocorre como resultado de uma operação de classificação de cima para baixo.
onSelectionChanged	Ocorre quando a seleção é alterada em uma planilha específica.
onSingleClicked	Ocorre quando uma ação clicada/grampeada à esquerda acontece na planilha. Este evento não será disparado ao clicar nos seguintes casos: O usuário arrasta o mouse para várias seleções. O usuário seleciona uma célula no modo quando os argumentos de célula são selecionados para referências de fórmula.
onVisibilityChanged	Ocorre quando a visibilidade da planilha é alterada.

Detalhes da propriedade

autoFilter

Representa o AutoFilter objeto da planilha.

readonly autoFilter: Excel.AutoFilter;

Valor da propriedade

Excel.AutoFilter

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function adds a percentage AutoFilter to the active worksheet 
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
    // Retrieve the active worksheet and the used range on that worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // Add a filter that will only show the rows with the top 50% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, {
        criterion1: "50",
        filterOn: Excel.FilterOn.topPercent
    });

    await context.sync();
});

charts

Retorna uma coleção de gráficos que fazem parte da planilha.

readonly charts: Excel.ChartCollection;

Valor da propriedade

Excel.ChartCollection

Comentários

comments

Retorna um conjunto de todos os objetos Comments na planilha.

readonly comments: Excel.CommentCollection;

Valor da propriedade

Excel.CommentCollection

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

Excel.RequestContext

customProperties

Obtém uma coleção de propriedades personalizadas no nível da planilha.

readonly customProperties: Excel.WorksheetCustomPropertyCollection;

Valor da propriedade

Excel.WorksheetCustomPropertyCollection

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml

await Excel.run(async (context) => {
  // Load the keys and values of all custom properties in the current worksheet.
  const customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties;
  customWorksheetProperties.load(["key", "value"]);
  await context.sync();

  // Log each custom property to the console.
  // Note that your document may have more properties than those you have set using this snippet.
  customWorksheetProperties.items.forEach((property) => {
    console.log(`${property.key}:${property.value}`);
  });
});

enableCalculation

Determina se o Excel deve recalcular a planilha quando necessário. True se o Excel recalcular a planilha quando necessário. False se o Excel não recalcular a planilha.

enableCalculation: boolean;

Valor da propriedade

boolean

Comentários

freezePanes

Obtém um objeto que pode ser usado para manipular painéis congelados na planilha.

readonly freezePanes: Excel.WorksheetFreezePanes;

Valor da propriedade

Excel.WorksheetFreezePanes

Comentários

horizontalPageBreaks

Obtém a coleção de quebra de página horizontal da planilha. Esta coleção contém apenas quebras de página manuais.

readonly horizontalPageBreaks: Excel.PageBreakCollection;

Valor da propriedade

Excel.PageBreakCollection

Comentários

id

Retorna um valor que identifica de forma exclusiva a planilha em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a planilha seja renomeada ou movida.

readonly id: string;

Valor da propriedade

string

Comentários

name

O nome de exibição da planilha.

name: string;

Valor da propriedade

string

Comentários

namedSheetViews

Retorna uma coleção de exibições de planilha que estão presentes na planilha.

readonly namedSheetViews: Excel.NamedSheetViewCollection;

Valor da propriedade

Excel.NamedSheetViewCollection

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

names

Coleção de nomes com escopo para a planilha atual.

readonly names: Excel.NamedItemCollection;

Valor da propriedade

Excel.NamedItemCollection

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

pageLayout

Obtém o PageLayout objeto da planilha.

readonly pageLayout: Excel.PageLayout;

Valor da propriedade

Excel.PageLayout

Comentários

pivotTables

Coleção de Tabelas Dinâmicas que fazem parte da planilha.

readonly pivotTables: Excel.PivotTableCollection;

Valor da propriedade

Excel.PivotTableCollection

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml

await Excel.run(async (context) => {
  // Get the names of all the PivotTables in the current worksheet.
  const pivotTables = context.workbook.worksheets.getActiveWorksheet().pivotTables;
  pivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the current worksheet:")
  pivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

position

A posição baseada em zero da planilha na pasta de trabalho.

position: number;

Valor da propriedade

number

Comentários

Exemplos

// Set worksheet position.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.position = 2;
    await context.sync(); 
});

protection

Retorna o objeto de proteção de planilha para uma planilha.

readonly protection: Excel.WorksheetProtection;

Valor da propriedade

Excel.WorksheetProtection

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

Exemplos

// Unprotecting a worksheet with unprotect() will remove all 
// WorksheetProtectionOptions options applied to a worksheet.
// To remove only a subset of WorksheetProtectionOptions use the 
// protect() method and set the options you wish to remove to true.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sheet1");
  sheet.protection.protect({
    allowInsertRows: false, // Protect row insertion
    allowDeleteRows: true // Unprotect row deletion
  });
});

shapes

Retorna a coleção de todos os objetos Shape na planilha.

readonly shapes: Excel.ShapeCollection;

Valor da propriedade

Excel.ShapeCollection

Comentários

showGridlines

Especifica se as linhas de grade estão visíveis para o usuário.

showGridlines: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/gridlines.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.showGridlines = true;

    await context.sync();
});

showHeadings

Especifica se os títulos estão visíveis para o usuário.

showHeadings: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

slicers

Retorna uma coleção de segmentações que fazem parte da planilha.

readonly slicers: Excel.SlicerCollection;

Valor da propriedade

Excel.SlicerCollection

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Pivot");
    const slicer = sheet.slicers.add(
        "Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
        "Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
    );
    slicer.name = "Fruit Slicer";
    await context.sync();
});

standardHeight

Retorna a altura padrão de todas as linhas na planilha, em pontos.

readonly standardHeight: number;

Valor da propriedade

number

Comentários

standardWidth

Especifica a largura padrão (padrão) de todas as colunas na planilha. Uma unidade de largura de coluna equivale à largura de um caractere no estilo Normal. Para fontes proporcionais, será usada a largura do caractere 0 (zero).

standardWidth: number;

Valor da propriedade

number

Comentários

tabColor

A cor da guia da planilha. Ao recuperar a cor da guia, se a planilha estiver invisível, o valor será null. Se a planilha estiver visível, mas a cor da guia estiver definida como automática, uma cadeia de caracteres vazia será retornada. Caso contrário, a propriedade será definida como uma cor, no formulário #RRGGBB (por exemplo, "FFA500"). Ao definir a cor, use uma cadeia de caracteres vazia para definir uma cor "automática" ou uma cor real caso contrário.

tabColor: string;

Valor da propriedade

string

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/tab-color.yaml

await Excel.run(async (context) => {
    const activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.tabColor = "#FF0000";

    await context.sync();
});

tabId

Retorna um valor que representa essa planilha que pode ser lido pelo Open Office XML. Esse é um valor inteiro, que é diferente de worksheet.id (que retorna um identificador globalmente exclusivo) e worksheet.name (que retorna um valor como "Sheet1").

readonly tabId: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

tables

Coleção de tabelas que fazem parte da planilha.

readonly tables: Excel.TableCollection;

Valor da propriedade

Excel.TableCollection

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

tasks

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Retorna uma coleção de tarefas presentes na planilha.

readonly tasks: Excel.DocumentTaskCollection;

Valor da propriedade

Excel.DocumentTaskCollection

Comentários

verticalPageBreaks

Obtém a coleção de quebra de página vertical da planilha. Esta coleção contém apenas quebras de página manuais.

readonly verticalPageBreaks: Excel.PageBreakCollection;

Valor da propriedade

Excel.PageBreakCollection

Comentários

[ Conjunto de API: ExcelApi 1.1 para visibilidade de leitura; 1.2 para defini-la. ]

visibility

A visibilidade da planilha.

visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

Valor da propriedade

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"

Comentários

Detalhes do método

activate()

Ative a planilha na interface do usuário do Excel.

activate(): void;

Retornos

void

Comentários

Exemplos

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.activate();
    await context.sync(); 
});

calculate(markAllDirty)

Calcula todas as células em uma planilha.

calculate(markAllDirty: boolean): void;

Parâmetros

markAllDirty: boolean

True, para marcar tudo como sujo.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

copy(positionType, relativeTo)

Copia uma planilha e a coloca na posição especificada.

copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet;

Parâmetros

positionType: Excel.WorksheetPositionType

O local na pasta de trabalho para colocar a planilha recém-criada. O valor padrão é "Nenhum", que insere a planilha no início da planilha.

relativeTo: Excel.Worksheet

A planilha existente que determina a posição da planilha recém-criada. Isso só será necessário se positionType for "Antes" ou "Depois".

Retornos

Excel.Worksheet

A planilha recém-criada.

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-copy.yaml

await Excel.run(async (context) => {

    let myWorkbook = context.workbook;
    let sampleSheet = myWorkbook.worksheets.getActiveWorksheet();
    let copiedSheet = sampleSheet.copy("End")

    sampleSheet.load("name");
    copiedSheet.load("name");

    await context.sync();

    console.log("'" + sampleSheet.name + "' was copied to '" + copiedSheet.name + "'")
});

copy(positionTypeString, relativeTo)

Copia uma planilha e a coloca na posição especificada.

copy(positionTypeString?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet): Excel.Worksheet;

Parâmetros

positionTypeString: "None" | "Before" | "After" | "Beginning" | "End"

O local na pasta de trabalho para colocar a planilha recém-criada. O valor padrão é "Nenhum", que insere a planilha no início da planilha.

relativeTo: Excel.Worksheet

A planilha existente que determina a posição da planilha recém-criada. Isso só será necessário se positionType for "Antes" ou "Depois".

Retornos

Excel.Worksheet

A planilha recém-criada.

Comentários

delete()

Exclui a planilha da pasta de trabalho. Observe que, se a visibilidade da planilha estiver definida como "VeryHidden", a operação de exclusão falhará com uma exceção InvalidOperation . Primeiro, você deve alterar sua visibilidade para oculta ou visível antes de excluí-la.

delete(): void;

Retornos

void

Comentários

Exemplos

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.delete();
    await context.sync(); 
});

findAll(text, criteria)

Localiza todas as ocorrências da cadeia de caracteres determinada com base nos critérios especificados e as retorna como um RangeAreas objeto, compreendendo um ou mais intervalos retangulares.

findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Parâmetros

text: string

A cadeia de caracteres a ser encontrada.

criteria: Excel.WorksheetSearchCriteria

Critérios de pesquisa adicionais, incluindo se a pesquisa precisa corresponder a toda a célula ou ser sensível a casos.

Retornos

Excel.RangeAreas

Um RangeAreas objeto, composto por um ou mais intervalos retangulares, que corresponde aos critérios de pesquisa. Se nenhuma célula atender a esse critério, um ItemNotFound erro será gerado.

Comentários

findAllOrNullObject(text, criteria)

Localiza todas as ocorrências da cadeia de caracteres determinada com base nos critérios especificados e as retorna como um RangeAreas objeto, compreendendo um ou mais intervalos retangulares.

findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Parâmetros

text: string

A cadeia de caracteres a ser encontrada.

criteria: Excel.WorksheetSearchCriteria

Critérios de pesquisa adicionais, incluindo se a pesquisa precisa corresponder a toda a célula ou ser sensível a casos.

Retornos

Excel.RangeAreas

Um RangeAreas objeto, composto por um ou mais intervalos retangulares, que corresponde aos critérios de pesquisa. Se não houver correspondências, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-find-all.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const foundRanges = sheet.findAllOrNullObject("Complete", {
        completeMatch: true,
        matchCase: false
    });

    await context.sync();

    if (foundRanges.isNullObject) {
        console.log("No complete projects");
    } else {
        foundRanges.format.fill.color = "green"
    }
});

getCell(row, column)

Obtém o Range objeto que contém a célula única com base em números de linha e coluna. A célula pode estar fora dos limites de seu intervalo pai, desde que permaneça dentro da grade da planilha.

getCell(row: number, column: number): Excel.Range;

Parâmetros

row: number

O número da linha da célula a ser recuperada. Indexados com zero.

column: number

O número da coluna da célula a ser recuperada. Indexados com zero.

Retornos

Excel.Range

Comentários

Exemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const cell = worksheet.getCell(0,0);
    cell.load('address');
    await context.sync();

    console.log(cell.address);
});

getNext(visibleOnly)

Obtém a planilha que segue esta. Se não houver planilhas seguindo esta, esse método gerará um erro.

getNext(visibleOnly?: boolean): Excel.Worksheet;

Parâmetros

visibleOnly: boolean

Opcional. Se true, considerar apenas planilhas visíveis, ignorando todas as ocultas.

Retornos

Excel.Worksheet

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;

    // We don't want to include the default worksheet that was created
    // when the workbook was created, so our "firstSheet" will be the one
    // after the literal first. Note chaining of navigation methods.
    const firstSheet = sheets.getFirst().getNext();
    const lastSheet = sheets.getLast();
    const firstTaxRateRange = firstSheet.getRange("B2");
    const lastTaxRateRange = lastSheet.getRange("B2");

    firstSheet.load("name");
    lastSheet.load("name");
    firstTaxRateRange.load("text");
    lastTaxRateRange.load("text");

    await context.sync();

    let firstYear = firstSheet.name.substr(5, 4);
    let lastYear = lastSheet.name.substr(5, 4);
    console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`)

    await context.sync();
});

getNextOrNullObject(visibleOnly)

Obtém a planilha que segue esta. Se não houver planilhas seguindo esta, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Parâmetros

visibleOnly: boolean

Opcional. Se true, considerar apenas planilhas visíveis, ignorando todas as ocultas.

Retornos

Excel.Worksheet

Comentários

getPrevious(visibleOnly)

Obtém a planilha que precede essa. Se não houver planilhas anteriores, esse método gerará um erro.

getPrevious(visibleOnly?: boolean): Excel.Worksheet;

Parâmetros

visibleOnly: boolean

Opcional. Se true, considerar apenas planilhas visíveis, ignorando todas as ocultas.

Retornos

Excel.Worksheet

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;
    const currentSheet = sheets.getActiveWorksheet();
    const previousYearSheet = currentSheet.getPrevious();
    const currentTaxDueRange = currentSheet.getRange("C2");
    const previousTaxDueRange = previousYearSheet.getRange("C2");

    currentSheet.load("name");
    previousYearSheet.load("name");
    currentTaxDueRange.load("text");
    previousTaxDueRange.load("text");

    await context.sync();

    let currentYear = currentSheet.name.substr(5, 4);
    let previousYear = previousYearSheet.name.substr(5, 4);
    console.log("Two Year Tax Due Comparison", `Tax due for ${currentYear} was ${currentTaxDueRange.text[0][0]}\nTax due for ${previousYear} was ${previousTaxDueRange.text[0][0]}`)

    await context.sync();
});

getPreviousOrNullObject(visibleOnly)

Obtém a planilha que precede essa. Se não houver planilhas anteriores, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Parâmetros

visibleOnly: boolean

Opcional. Se true, considerar apenas planilhas visíveis, ignorando todas as ocultas.

Retornos

Excel.Worksheet

Comentários

getRange(address)

Obtém o Range objeto, representando um único bloco retangular de células, especificado pelo endereço ou nome.

getRange(address?: string): Excel.Range;

Parâmetros

address: string

Opcional. A cadeia de caracteres que representa o endereço ou o nome do intervalo. Por exemplo, "A1:B2". Caso não seja especificado, todo o intervalo da planilha será retornado.

Retornos

Excel.Range

Comentários

Exemplos

// Use the range address to get the range object.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    await context.sync();
    
    console.log(range.cellCount);
});

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Obtém o Range objeto começando em um índice de linha específico e índice de coluna e abrangendo um determinado número de linhas e colunas.

getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range;

Parâmetros

startRow: number

Linha inicial (indexada a zero).

startColumn: number

Coluna Iniciar (indexada a zero).

rowCount: number

Número de linhas a serem incluídas no intervalo.

columnCount: number

Número de colunas a serem incluídas no intervalo.

Retornos

Excel.Range

Comentários

getRanges(address)

Obtém o RangeAreas objeto, que representa um ou mais blocos de intervalos retangulares, especificados pelo endereço ou nome.

getRanges(address?: string): Excel.RangeAreas;

Parâmetros

address: string

Opcional. Uma cadeia de caracteres que contém os endereços separados por vírgula ou separados por ponto e vírgula ou nomes dos intervalos individuais. Por exemplo, "A1:B2, A5:B5" ou "A1:B2; A5:B5". Se não for especificado, um RangeAreas objeto para toda a planilha será retornado.

Retornos

Excel.RangeAreas

Comentários

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 specifiedRanges = sheet.getRanges("D3:D5, G3:G5");
    specifiedRanges.format.fill.color = "pink";

    await context.sync();
})

getUsedRange(valuesOnly)

O intervalo usado é o menor intervalo que abrange todas as células que têm um valor ou uma formatação atribuída a elas. Se toda a planilha estiver em branco, essa função retornará a célula superior esquerda (ou seja, não gerará um erro).

getUsedRange(valuesOnly?: boolean): Excel.Range;

Parâmetros

valuesOnly: boolean

Opcional. Se true, considerará apenas células com valores como células usadas (ignorando a formatação). [Conjunto de API: ExcelApi 1.2]

Retornos

Excel.Range

Comentários

Exemplos

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    const usedRange = worksheet.getUsedRange();
    usedRange.load('address');
    await context.sync();
    
    console.log(usedRange.address);
});

getUsedRangeOrNullObject(valuesOnly)

O intervalo usado é o menor intervalo que abrange todas as células que têm um valor ou uma formatação atribuída a elas. Se toda a planilha estiver em branco, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Parâmetros

valuesOnly: boolean

Opcional. Considera apenas as células com valores como células usadas.

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

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.WorksheetLoadOptions): Excel.Worksheet;

Parâmetros

options: Excel.Interfaces.WorksheetLoadOptions

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

Retornos

Excel.Worksheet

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

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.Worksheet

Exemplos

// Get worksheet properties based on sheet name.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.load('position')
    await context.sync();
    
    console.log(worksheet.position);
});

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

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.Worksheet

replaceAll(text, replacement, criteria)

Localiza e substitui a cadeia de caracteres fornecida com base nos critérios especificados na planilha atual.

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Parâmetros

text: string

Cadeia de caracteres a ser encontrada.

replacement: string

A cadeia de caracteres que substitui a cadeia de caracteres original.

criteria: Excel.ReplaceCriteria

Critérios de substituição adicionais.

Retornos

OfficeExtension.ClientResult<number>

O número de substituições executadas.

Comentários

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.WorksheetUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties: Excel.Interfaces.WorksheetUpdateData

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

Exemplos

// Set the color and name of the current worksheet.
await Excel.run(async (context) => {
  const activeSheet = context.workbook.worksheets.getActiveWorksheet();
  activeSheet.set({
    tabColor: "yellow",
    name: "MySheet"
  });

  await context.sync();
});

set(properties)

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

set(properties: Excel.Worksheet): void;

Parâmetros

properties: Excel.Worksheet

Retornos

void

showOutlineLevels(rowLevels, columnLevels)

Mostra grupos de linhas ou colunas pelos níveis de contorno. Descreve grupos e resume uma lista de dados na planilha. Os rowLevels parâmetros e columnLevels especificam quantos níveis do contorno serão exibidos. O intervalo de argumentos aceitável está entre 0 e 8. Um valor de 0 não altera a exibição atual. Um valor maior que o número atual de níveis exibe todos os níveis.

showOutlineLevels(rowLevels: number, columnLevels: number): void;

Parâmetros

rowLevels: number

O número de níveis de linha de um contorno a ser exibido.

columnLevels: number

O número de níveis de coluna de um contorno a ser exibido.

Retornos

void

Comentários

OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>

Exemplos

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

Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This shows the top 3 outline levels; collapsing any additional sublevels.
    sheet.showOutlineLevels(3, 3);
    await context.sync();
});

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

toJSON(): Excel.Interfaces.WorksheetData;

Retornos

Excel.Interfaces.WorksheetData

Detalhes do evento

onActivated

Ocorre quando a planilha é ativada.

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;

Tipo de evento

Comentários

OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>

Exemplos

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onActivated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The activated worksheet ID is: " + event.worksheetId);
            await context.sync();
        });
    });
    await context.sync();
});

onCalculated

Ocorre quando a planilha é calculada.

readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Exemplos

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onCalculated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The worksheet has recalculated.");
            await context.sync();
        });
    });
    await context.sync();
});

onChanged

Ocorre quando os dados são alterados em uma planilha específica.

readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>

Comentários

OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onChanged.add(onChange);
    await context.sync();

    console.log("Added a worksheet-level data-changed event handler.");
});

onColumnSorted

Ocorre quando uma ou mais colunas são classificadas. Isso acontece como resultado de uma operação de classificação da esquerda para a direita.

readonly onColumnSorted: OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>;

Tipo de evento

Comentários

OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

await Excel.run(async (context) => {
    console.log("Adding column handler");
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This will fire whenever a column has been moved as the result of a sort action.
    sheet.onColumnSorted.add((event) => {
        return Excel.run((context) => {
            console.log("Column sorted: " + event.address);
            const sheet = context.workbook.worksheets.getActiveWorksheet();

            // Clear formatting for section, then highlight the sorted area.
            sheet.getRange("A1:E5").format.fill.clear();
            if (event.address !== "") {
                sheet.getRanges(event.address).format.fill.color = "yellow";
            }

            return context.sync();
        });
    });
});

onDeactivated

Ocorre quando a planilha é desativada.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;

Tipo de evento

Comentários

OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>

Exemplos

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onDeactivated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The deactivated worksheet is: " + event.worksheetId);
            await context.sync();
        });
    });
    await context.sync();
});

onFiltered

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Ocorre quando um filtro é aplicado em uma planilha específica.

readonly onFiltered: OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>;

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

onFormatChanged

Ocorre quando o formato é alterado em uma planilha específica.

readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>

Comentários

OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>

onFormulaChanged

Ocorre quando uma ou mais fórmulas são alteradas nesta planilha. Esse evento é para quando a fórmula em si é alterada, não o valor de dados resultante do cálculo da fórmula.

readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.13 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-formula-changed.yaml

await Excel.run(async (context) => {
  // Retrieve the worksheet named "Sample".
  let sheet = context.workbook.worksheets.getItem("Sample");
  
  // Register the formula changed event handler for this worksheet.
  sheet.onFormulaChanged.add(formulaChangeHandler);
  await context.sync();
  
  console.log("Registered a formula changed event handler for this worksheet.");
});

...

async function formulaChangeHandler(event: Excel.WorksheetFormulaChangedEventArgs) {
  await Excel.run(async (context) => {
    // Retrieve details about the formula change event.
    const cellAddress = event.formulaDetails[0].cellAddress;
    const previousFormula = event.formulaDetails[0].previousFormula;
    const source = event.source;
    
    // Print out the change event details.
    console.log(
      `The formula in cell ${cellAddress} changed. 
      The previous formula was: ${previousFormula}. 
      The source of the change was: ${source}.`
    );
  });
}

onNameChanged

Ocorre quando o nome da planilha é alterado.

readonly onNameChanged: OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.17 ]

onProtectionChanged

Ocorre quando o estado de proteção de planilha é alterado.

readonly onProtectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml

// This function registers an event handler for the onProtectionChanged event of a worksheet.
await Excel.run(async (context) => {
    // Set "Sample" as the active worksheet.
    context.workbook.worksheets.getItemOrNullObject("Sample").delete();
    const sheet = context.workbook.worksheets.add("Sample");
    sheet.activate();

    // Register the onProtectionChanged event handler.
    sheet.onProtectionChanged.add(checkProtection);
    await context.sync();
    console.log("Added a worksheet protection change event handler.");
});

...

async function checkProtection(event: Excel.WorksheetProtectionChangedEventArgs) {
    // This function is an event handler that returns the protection status of a worksheet
    // and information about the changed worksheet.
    await Excel.run(async (context) => {
        const protectionStatus = event.isProtected;
        const worksheetId = event.worksheetId;
        const source = event.source;
        console.log("Protection status changed. Protection status is now: " + protectionStatus + ".");
        console.log("    ID of changed worksheet: " + worksheetId + ".");
        console.log("    Source of change event: " + source + ".");
    });
}

onRowHiddenChanged

Ocorre quando o estado oculto de uma ou mais linhas é alterado em uma planilha específica.

readonly onRowHiddenChanged: OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

Exemplos

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.onRowHiddenChanged.add(function (event) {
        return Excel.run(async (context) => {
            console.log(`Row ${event.address} is now ${event.changeType}`);
            await context.sync();
        });
    });
    await context.sync();
});

onRowSorted

Ocorre quando uma ou mais linhas são classificadas. Isso ocorre como resultado de uma operação de classificação de cima para baixo.

readonly onRowSorted: OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>

Comentários

OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

await Excel.run(async (context) => {
    console.log("Adding row handler");
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This will fire whenever a row has been moved as the result of a sort action.
    sheet.onRowSorted.add((event) => {
        return Excel.run((context) => {
            console.log("Row sorted: " + event.address);
            const sheet = context.workbook.worksheets.getActiveWorksheet();

            // Clear formatting for section, then highlight the sorted area.
            sheet.getRange("A1:E5").format.fill.clear();
            if (event.address !== "") {
                sheet.getRanges(event.address).format.fill.color = "yellow";
            }

            return context.sync();
        });
    });
});

onSelectionChanged

Ocorre quando a seleção é alterada em uma planilha específica.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>;

Tipo de evento

Comentários

OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>

Exemplos

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onSelectionChanged.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The selected range has changed to: " + event.address);
            await context.sync();
        });
    });
    await context.sync();
});

onSingleClicked

Ocorre quando uma ação clicada/grampeada à esquerda acontece na planilha. Este evento não será disparado ao clicar nos seguintes casos:

O usuário arrasta o mouse para várias seleções.
O usuário seleciona uma célula no modo quando os argumentos de célula são selecionados para referências de fórmula.

readonly onSingleClicked: OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>;

Tipo de evento

Comentários