Excel.WorksheetCollection interface

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

Métodos

add(name)

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

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 worksheet usando o Nome ou ID dele.

getItemOrNullObject(key)

Obtém um objeto worksheet usando o Nome ou ID dele. Se a planilha não existir, retornará um objeto null.

getLast(visibleOnly)

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

load(propertyNames)

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

Detalhes do método

add(name)

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

add(name?: string): 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

getActiveWorksheet()

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

getActiveWorksheet(): Worksheet;

Retornos

getCount(visibleOnly)

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

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

Parâmetros

visibleOnly
boolean

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

Retornos

ClientResult<number>

getFirst(visibleOnly)

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

getFirst(visibleOnly?: boolean): Worksheet;

Parâmetros

visibleOnly
boolean

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

Retornos

Exemplos

async function main(context: Excel.RequestContext) {
    let 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.
    let firstSheet = sheets.getFirst().getNext();
    let lastSheet = sheets.getLast();
    let firstTaxRateRange = firstSheet.getRange("B2");
    let 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 worksheet usando o Nome ou ID dele.

getItem(key: string): Worksheet;

Parâmetros

key
string

O Nome ou ID da planilha.

Retornos

getItemOrNullObject(key)

Obtém um objeto worksheet usando o Nome ou ID dele. Se a planilha não existir, retornará um objeto null.

getItemOrNullObject(key: string): Worksheet;

Parâmetros

key
string

O Nome ou ID da planilha.

Retornos

getLast(visibleOnly)

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

getLast(visibleOnly?: boolean): Worksheet;

Parâmetros

visibleOnly
boolean

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

Retornos

Exemplos

async function main(context: Excel.RequestContext) {
    let 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.
    let firstSheet = sheets.getFirst().getNext();
    let lastSheet = sheets.getLast();
    let firstTaxRateRange = firstSheet.getRange("B2");
    let 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(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[]): void;

Parâmetros

propertyNames
string | string[]

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

Retornos

void