Excel.WorksheetCollection class

Representa uma coleção de todos os objetos da planilha que fazem parte da pasta de trabalho.

Comentários

Usada por

Excel.Pasta de trabalho: planilhas

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
items	Obtém os itens filhos carregados nesta coleção.

Métodos

add(name)	Adiciona uma nova planilha à pasta de trabalho. A planilha será adicionada ao final das planilhas existentes. Se quiser ativar a planilha recém-adicionada, chame-a `.activate()` .
addFromBase64(base64File, sheetNamesToInsert, positionType, relativeTo)	Insere as planilhas especificadas de uma pasta de trabalho na pasta de trabalho atual. Observação: no momento, essa API só tem suporte para o Office no Windows e no Mac. E ele foi preterido.`Workbook.insertWorksheetFromBase64`
addFromBase64(base64File, sheetNamesToInsert, positionType, relativeTo)	Insere as planilhas especificadas de uma pasta de trabalho na pasta de trabalho atual. Observação: no momento, essa API só tem suporte para o Office no Windows e no Mac. E ele foi preterido.`Workbook.insertWorksheetFromBase64`
getActiveWorksheet()	Obtém a planilha ativa no momento na pasta de trabalho.
getCount(visibleOnly)	Obtém o número de planilhas na coleção.
getFirst(visibleOnly)	Obtém a primeira planilha na coleção.
getItem(key)	Obtém um objeto de planilha usando o nome ou ID dele.
getItemOrNullObject(key)	Obtém um objeto de planilha usando o nome ou ID dele. 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.
getLast(visibleOnly)	Obtém a última planilha na coleção.
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.stringify`, por sua vez, chama o `toJSON` método do objeto que é passado para ele.) Enquanto o objeto original `Excel.WorksheetCollection` é um objeto API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Excel.Interfaces.WorksheetCollectionData`) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.

Eventos

onActivated	Ocorre quando qualquer planilha na pasta de trabalho é ativada.
onAdded	Ocorre quando uma nova planilha é adicionada à pasta de trabalho.
onCalculated	Ocorre quando qualquer planilha na pasta de trabalho é calculada.
onCalculationBusy	Ocorre quando as células na planilha estão sendo calculadas de forma assíncrona. Esse evento é acionado no final de um ciclo de cálculo, semelhante ao `onCalculated` evento. Normalmente, quando o cálculo é concluído para uma célula, o `onCalculated` evento é disparado. No entanto, se o cálculo colocar um valor pendente transitório (como "#BUSY!") na célula, ele `onCalculationBusy` será acionado para indicar que o estado da célula foi alterado, embora o cálculo do valor final ainda não esteja concluído. Quando um ciclo de cálculo subsequente conclui o cálculo dessa célula, o `onCalculated` evento é disparado. Recursos de fórmula, como JavaScript User-Defined Functions e fórmulas =PY, podem disparar esse evento.
onChanged	Ocorre quando uma planilha da pasta de trabalho é alterada.
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 qualquer planilha na pasta de trabalho é desativada.
onDeleted	Ocorre quando uma planilha é excluída da pasta de trabalho.
onFiltered	Ocorre quando filtro de uma planilha é aplicado na pasta de trabalho.
onFormatChanged	Ocorre quando qualquer planilha na pasta de trabalho tem um formato alterado.
onFormulaChanged	Ocorre quando uma ou mais fórmulas são alteradas em qualquer planilha desta coleção. Esse evento é para quando a fórmula em si é alterada, e não o valor de dados resultante do cálculo da fórmula.
onMoved	Ocorre quando uma planilha é movida dentro de uma pasta de trabalho. Esse evento só é disparado quando uma planilha é movida diretamente dentro de uma pasta de trabalho. Esse evento não é disparado quando a posição de uma planilha é alterada indiretamente, como quando uma nova planilha é inserida e faz com que planilhas existentes mudem de posição.
onNameChanged	Ocorre quando o nome da planilha é alterado na coleção de planilhas.
onProtectionChanged	Ocorre quando o estado de proteção da 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.
onSingleClicked	Ocorre quando a operação clicada com o botão esquerdo/tocado ocorre na coleção de planilhas. Este evento não será acionado ao clicar nos seguintes casos: - O usuário arrasta o mouse para seleção múltipla. - O usuário seleciona uma célula no modo em que os argumentos de célula são selecionados para referências de fórmula.
onVisibilityChanged	Ocorre quando a visibilidade da planilha é alterada na coleção de planilhas.

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

items

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.Worksheet[];

Valor da propriedade

Excel.Worksheet[]

add(name)

Adiciona uma nova planilha à pasta de trabalho. A planilha será adicionada ao final das planilhas existentes. Se quiser ativar a planilha recém-adicionada, chame-a .activate() .

add(name?: string): Excel.Worksheet;

Parâmetros

name: string

Opcional. O nome da planilha a ser adicionada. Se especificado, o nome deve ser exclusivo. Se não especificado, o Excel determina o nome da nova planilha.

Retornos

Excel.Worksheet

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

await Excel.run(async (context) => { 
    const wSheetName = 'Sample Name';
    const worksheet = context.workbook.worksheets.add(wSheetName);
    worksheet.load('name');
    await context.sync();
    
    console.log(worksheet.name);
});

addFromBase64(base64File, sheetNamesToInsert, positionType, relativeTo)

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.

Insere as planilhas especificadas de uma pasta de trabalho na pasta de trabalho atual.

Observação: no momento, essa API só tem suporte para o Office no Windows e no Mac. E ele foi preterido.Workbook.insertWorksheetFromBase64

addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet | string): OfficeExtension.ClientResult<string[]>;

Parâmetros

base64File: string

Obrigatório. A cadeia de caracteres codificada em Base64 que representa o arquivo de pasta de trabalho de origem.

sheetNamesToInsert: string[]

Opcional. Os nomes das planilhas individuais a serem inseridas. Por padrão, todas as planilhas da pasta de trabalho de origem são inseridas.

positionType: Excel.WorksheetPositionType

Opcional. Onde na pasta de trabalho atual as novas planilhas serão inseridas. Consulte Excel.WorksheetPositionType para obter detalhes. O padrão é "Iniciar".

relativeTo: Excel.Worksheet | string

Opcional. A planilha na pasta de trabalho atual referenciada para o positionType parâmetro. O padrão é null e, com base em positionType, ele inserirá planilhas no início ou no final da pasta de trabalho atual.

Retornos

OfficeExtension.ClientResult<string[]>

Uma matriz de IDs correspondente a cada planilha recém-inserida.

Comentários

Conjunto de APIs: ExcelApi BETA (SOMENTE VISUALIZAÇÃO)

addFromBase64(base64File, sheetNamesToInsert, positionType, relativeTo)

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.

Insere as planilhas especificadas de uma pasta de trabalho na pasta de trabalho atual.

Observação: no momento, essa API só tem suporte para o Office no Windows e no Mac. E ele foi preterido.Workbook.insertWorksheetFromBase64

addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Worksheet | string): OfficeExtension.ClientResult<string[]>;

Parâmetros

base64File: string

Obrigatório. A cadeia de caracteres codificada em Base64 que representa o arquivo de pasta de trabalho de origem.

sheetNamesToInsert: string[]

Opcional. Os nomes das planilhas individuais a serem inseridas. Por padrão, todas as planilhas da pasta de trabalho de origem são inseridas.

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

Opcional. Onde na pasta de trabalho atual as novas planilhas serão inseridas. Consulte Excel.WorksheetPositionType para obter detalhes. O padrão é "Iniciar".

relativeTo: Excel.Worksheet | string

Opcional. A planilha na pasta de trabalho atual referenciada para o positionType parâmetro. O padrão é null e, com base em positionType, ele inserirá planilhas no início ou no final da pasta de trabalho atual.

Retornos

OfficeExtension.ClientResult<string[]>

Uma matriz de IDs correspondente a cada planilha recém-inserida.

Comentários

Conjunto de APIs: ExcelApi BETA (SOMENTE VISUALIZAÇÃO)

getActiveWorksheet()

Obtém a planilha ativa no momento na pasta de trabalho.

getActiveWorksheet(): Excel.Worksheet;

Retornos

Excel.Worksheet

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

await Excel.run(async (context) => {  
    const activeWorksheet = context.workbook.worksheets.getActiveWorksheet();
    activeWorksheet.load('name');
    await context.sync();
    console.log(activeWorksheet.name);
});

getCount(visibleOnly)

Obtém o número de planilhas na coleção.

getCount(visibleOnly?: boolean): OfficeExtension.ClientResult<number>;

Parâmetros

visibleOnly: boolean

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

Retornos

OfficeExtension.ClientResult<number>

Comentários

Conjunto de APIs: ExcelApi 1.4

getFirst(visibleOnly)

Obtém a primeira planilha na coleção.

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

Parâmetros

visibleOnly: boolean

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

Retornos

Excel.Worksheet

Comentários

Conjunto de APIs: ExcelApi 1.5

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

getItem(key)

Obtém um objeto de planilha usando o nome ou ID dele.

getItem(key: string): Excel.Worksheet;

Parâmetros

key: string

O nome ou a ID da planilha.

Retornos

Excel.Worksheet

Comentários

Conjunto de APIs: ExcelApi 1.1

getItemOrNullObject(key)

Obtém um objeto de planilha usando o nome ou ID dele. 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.

getItemOrNullObject(key: string): Excel.Worksheet;

Parâmetros

key: string

O nome ou a ID da planilha.

Retornos

Excel.Worksheet

Comentários

Conjunto de APIs: ExcelApi 1.4

getLast(visibleOnly)

Obtém a última planilha na coleção.

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

Parâmetros

visibleOnly: boolean

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

Retornos

Excel.Worksheet

Comentários

Conjunto de APIs: ExcelApi 1.5

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

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.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCollection;

Parâmetros

options: Excel.Interfaces.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

Excel.WorksheetCollection

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

Parâmetros

propertyNames: string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

Retornos

Excel.WorksheetCollection

Exemplos

await Excel.run(async (context) => { 
    const worksheets = context.workbook.worksheets;
    worksheets.load('items');
    await context.sync();
    
    for (let i = 0; i < worksheets.items.length; i++) {
        console.log(worksheets.items[i].name);
    }
});

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?: OfficeExtension.LoadOption): Excel.WorksheetCollection;

Parâmetros

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.WorksheetCollection

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 original Excel.WorksheetCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorksheetCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.WorksheetCollectionData;

Retornos

Excel.Interfaces.WorksheetCollectionData

onActivated

Ocorre quando qualquer planilha na pasta de trabalho é ativada.

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.7

Exemplos

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

await Excel.run(async (context) => {
    let sheets = context.workbook.worksheets;
    sheets.onActivated.add(onActivate);

    await context.sync();
    console.log("A handler has been registered for the OnActivate event.");
});

onAdded

Ocorre quando uma nova planilha é adicionada à pasta de trabalho.

readonly onAdded: OfficeExtension.EventHandlers<Excel.WorksheetAddedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetAddedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.7

Exemplos

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

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets;
    sheet.onAdded.add(onWorksheetAdd);

    await context.sync();
    console.log("A handler has been registered for the OnAdded event.");
});

onCalculated

Ocorre quando qualquer planilha na pasta de trabalho é calculada.

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.8

onCalculationBusy

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 as células na planilha estão sendo calculadas de forma assíncrona.

Esse evento é acionado no final de um ciclo de cálculo, semelhante ao onCalculated evento. Normalmente, quando o cálculo é concluído para uma célula, o onCalculated evento é disparado. No entanto, se o cálculo colocar um valor pendente transitório (como "#BUSY!") na célula, ele onCalculationBusy será acionado para indicar que o estado da célula foi alterado, embora o cálculo do valor final ainda não esteja concluído. Quando um ciclo de cálculo subsequente conclui o cálculo dessa célula, o onCalculated evento é disparado.

Recursos de fórmula, como JavaScript User-Defined Functions e fórmulas =PY, podem disparar esse evento.

readonly onCalculationBusy: OfficeExtension.EventHandlers<Excel.WorksheetCalculationBusyEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetCalculationBusyEventArgs>

Comentários

Conjunto de APIs: ExcelApi BETA (SOMENTE VISUALIZAÇÃO)

onChanged

Ocorre quando uma planilha da pasta de trabalho é alterada.

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.9

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

OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.10

onDeactivated

Ocorre quando qualquer planilha na pasta de trabalho é desativada.

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.7

Exemplos

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

await Excel.run(async (context) => {
    let sheets = context.workbook.worksheets;
    sheets.onDeactivated.add(onDeactivate);

    await context.sync();
    console.log("A handler has been registered for the OnDeactivate event.");
});

onDeleted

Ocorre quando uma planilha é excluída da pasta de trabalho.

readonly onDeleted: OfficeExtension.EventHandlers<Excel.WorksheetDeletedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetDeletedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.7

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 filtro de uma planilha é aplicado na pasta de trabalho.

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>

Comentários

Conjunto de APIs: ExcelApi BETA (SOMENTE VISUALIZAÇÃO)

onFormatChanged

Ocorre quando qualquer planilha na pasta de trabalho tem um formato alterado.

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.9

onFormulaChanged

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.13

onMoved

Ocorre quando uma planilha é movida dentro de uma pasta de trabalho. Esse evento só é disparado quando uma planilha é movida diretamente dentro de uma pasta de trabalho. Esse evento não é disparado quando a posição de uma planilha é alterada indiretamente, como quando uma nova planilha é inserida e faz com que planilhas existentes mudem de posição.

readonly onMoved: OfficeExtension.EventHandlers<Excel.WorksheetMovedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetMovedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.17

onNameChanged

Ocorre quando o nome da planilha é alterado na coleção de planilhas.

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.17

onProtectionChanged

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.14

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 APIs: ExcelApi 1.11

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

Conjunto de APIs: ExcelApi 1.10

onSelectionChanged

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.9

onSingleClicked

Ocorre quando a operação clicada com o botão esquerdo/tocado ocorre na coleção de planilhas. Este evento não será acionado ao clicar nos seguintes casos: - O usuário arrasta o mouse para seleção múltipla. - O usuário seleciona uma célula no modo em que os argumentos de célula são selecionados para referências de fórmula.

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.10

onVisibilityChanged

Ocorre quando a visibilidade da planilha é alterada na coleção de planilhas.

readonly onVisibilityChanged: OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>

Comentários

Conjunto de APIs: ExcelApi 1.17

Comentários

Usada por

Propriedades

Métodos

Eventos

Detalhes da propriedade

context

Valor da propriedade

items

Valor da propriedade

Detalhes do método

add(name)

Parâmetros

Retornos

Comentários

Exemplos

addFromBase64(base64File, sheetNamesToInsert, positionType, relativeTo)

Parâmetros

Retornos

Comentários

addFromBase64(base64File, sheetNamesToInsert, positionType, relativeTo)

Parâmetros

Retornos

Comentários

getActiveWorksheet()

Retornos

Comentários

Exemplos

getCount(visibleOnly)

Parâmetros

Retornos

Comentários

getFirst(visibleOnly)

Parâmetros

Retornos

Comentários

Exemplos

getItem(key)

Parâmetros

Retornos

Comentários

getItemOrNullObject(key)

Parâmetros

Retornos

Comentários

getLast(visibleOnly)

Parâmetros

Retornos

Comentários

Exemplos

load(options)

Parâmetros

Retornos

load(propertyNames)

Parâmetros

Retornos

Exemplos

load(propertyNamesAndPaths)

Parâmetros

Retornos

toJSON()

Retornos

Detalhes do evento

onActivated

Tipo de evento

Comentários

Exemplos

onAdded

Tipo de evento

Comentários

Exemplos

onCalculated

Tipo de evento

Comentários

onCalculationBusy

Tipo de evento

Comentários

onChanged

Tipo de evento