Definir o formato de intervalo com a API JavaScript do Excel

Este artigo fornece exemplos de código que definem a formatação para células num intervalo com a API JavaScript do Excel. A formatação inclui tipos de letra, cores, formatos de número, limites e alinhamento. Para obter a lista completa de propriedades e métodos suportados pelo Range objeto, consulte Excel.Range class (Classe Excel.Range).

Observação

A API JavaScript do Excel não tem um objeto ou classe "Célula". Em vez disso, a API JavaScript do Excel define todas as células do Excel como objetos Range. Uma célula individual na interface do usuário do Excel se traduz em um objeto Range com uma célula na API JavaScript do Excel. Um único objeto Range também pode conter várias células contíguas. Confira Trabalhar com células usando a API JavaScript do Excel para saber mais.

Principais pontos

  • Utilize Range.format para aceder a propriedades de formatação como tipo de letra, preenchimento, limites e alinhamento.
  • Definir format.fill.color e format.font.color utilizar nomes de cores ou códigos hexadecimais.
  • Utilize numberFormat para controlar a forma como os números, as datas e a moeda são apresentados.
  • As alterações de formatação não afetam os valores das células, apenas o seu aspeto.

Definir cor da fonte e cor de preenchimento

As Range.format.font propriedades e Range.format.fill controlam o texto e as cores de fundo. Utilize nomes de cores como "vermelho" ou "branco" ou códigos de cores hexadecimais como "#4472C4".

O exemplo de código a seguir define a cor da fonte e a cor de preenchimento para células no intervalo B2:E2.

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

    let range = sheet.getRange("B2:E2");
    range.format.fill.color = "#4472C4";
    range.format.font.color = "white";

    await context.sync();
});

Dados no intervalo antes da definição da cor da fonte e da cor de preenchimento

Dados no Excel antes de o formato ser definido.

Dados no intervalo após a definição da cor da fonte e da cor de preenchimento

Dados no Excel após o formato ser definido.

Definir formato de número

A numberFormat propriedade controla a forma como os valores são apresentados nas células. Os códigos de formato de número seguem a sintaxe de formatação do Excel. Os formatos comuns incluem "0,00" para casas decimais, "$#,##0,00" para moeda e "m/d/aaaa" para datas.

O seguinte exemplo de código define o formato de número das células no intervalo D3:E5 para mostrar duas casas decimais.

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

    let formats = [
        ["0.00", "0.00"],
        ["0.00", "0.00"],
        ["0.00", "0.00"]
    ];

    let range = sheet.getRange("D3:E5");
    range.numberFormat = formats;

    await context.sync();
});

Dados no intervalo antes da definição do formato de número

Dados no Excel antes de o formato de número ser definido.

Dados no intervalo após a definição do formato de número

Dados no Excel após a definição do formato de número.

Definir propriedades do tipo de letra

Defina várias propriedades do tipo de letra, incluindo negrito, itálico, tamanho e nome do tipo de letra.

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getActiveWorksheet();
    let range = sheet.getRange("B2:E2");

    range.format.font.bold = true;
    range.format.font.italic = true;
    range.format.font.size = 14;
    range.format.font.name = "Arial";

    await context.sync();
});

Definir alinhamento de células

As horizontalAlignment propriedades e verticalAlignment controlam a forma como o conteúdo é posicionado dentro das células.

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let range = sheet.getRange("A1:E1");

    range.format.horizontalAlignment = Excel.HorizontalAlignment.center;
    range.format.verticalAlignment = Excel.VerticalAlignment.center;

    await context.sync();
});

Confira também