Excel.WorksheetCollection class

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

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

readonly items: Excel.Worksheet[];

Valor da propriedade

Adiciona uma nova planilha à pasta de trabalho. A planilha será adicionada ao final das planilhas existentes. Se pretender ativar a folha de cálculo adicionada recentemente, chame-a .activate() .

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

Parâmetros

Retornos

Comentários

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

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

Nota*: Atualmente, esta API só é suportada para o Office no Windows e Mac. E foi preterido. Em vez disso, utilize Workbook.insertWorksheetFromBase64 .

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

Parâmetros

Retornos

Uma matriz de IDs correspondente a cada folha de cálculo recentemente inserida.

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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

Nota*: Atualmente, esta API só é suportada para o Office no Windows e Mac. E foi preterido. Em vez disso, utilize Workbook.insertWorksheetFromBase64 .

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

Parâmetros

Retornos

Uma matriz de IDs correspondente a cada folha de cálculo recentemente inserida.

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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

getActiveWorksheet(): Excel.Worksheet;

Retornos

Comentários

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

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: 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();
});

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

getItem(key: string): Excel.Worksheet;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

getItemOrNullObject(key: string): Excel.Worksheet;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: 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();
});

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

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Excel.WorksheetCollection;

Parâmetros

Retornos

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

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

Retornos

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

toJSON(): Excel.Interfaces.WorksheetCollectionData;

Retornos

Ocorre quando uma folha de cálculo no livro é ativada.

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

Tipo de evento

Comentários

[ Conjunto de API: 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.");
});

Ocorre quando uma nova folha de cálculo é adicionada ao livro.

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

Tipo de evento

Comentários

[ Conjunto de API: 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.");
});

Ocorre quando uma folha de cálculo no livro é calculada.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Ocorre quando uma planilha da pasta de trabalho é alterada.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.10 ]

Ocorre quando uma folha de cálculo no livro é desativada.

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

Tipo de evento

Comentários

[ Conjunto de API: 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.");
});

Ocorre quando uma folha de cálculo é eliminada do livro.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Ocorre quando filtro de uma planilha é aplicado na pasta de trabalho.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Ocorre quando uma folha de cálculo no livro tem um formato alterado.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Ocorre quando uma ou mais fórmulas são alteradas em qualquer folha de cálculo desta coleção. Este evento destina-se a quando a própria fórmula é alterada e 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 ]

Ocorre quando uma folha de cálculo é movida dentro de um livro. Este evento só é acionado quando uma folha de cálculo é movida diretamente dentro de um livro. Este evento não é acionado quando a posição de uma folha de cálculo é alterada indiretamente, como quando uma nova folha de cálculo é inserida e faz com que as folhas de cálculo existentes alterem as posições.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.17 ]

Ocorre quando o nome da folha de cálculo é alterado na coleção de folhas de cálculo.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.17 ]

Ocorre quando o estado de proteção da folha de cálculo é alterado.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

Ocorre quando o estado oculto de uma ou mais linhas foi alterado numa folha de cálculo específica.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

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

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Ocorre quando a operação clicada/tocada à esquerda ocorre na coleção de folhas de cálculo. Este evento não será acionado ao clicar nos seguintes casos: – O utilizador arrasta o rato para seleção múltipla. - O utilizador seleciona uma célula no modo quando os argumentos de célula são selecionados para referências de fórmulas.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Ocorre quando a visibilidade da folha de cálculo é alterada na coleção de folhas de cálculo.

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

Tipo de evento

Comentários

[ Conjunto de API: ExcelApi 1.17 ]