Excel.RangeFont class

Representa o status de negrito da fonte.

bold: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

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

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const sumRange = sheet.getRange("F4");
  sumRange.formulas = [["=SUM(B4:E4)"]];
  sumRange.format.fill.color = "LightBlue";
  sumRange.format.font.bold = true;
  sheet.getRanges("K4,P4").copyFrom("F4", Excel.RangeCopyType.all);
  sheet.getRanges("F4,K4,P4").format.autofitColumns();
  await context.sync();
});

Representação da cor do texto no código de cores HTML (por exemplo, #FF0000 representa vermelho).

color: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

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

// Get the font properties for the header range.
await Excel.run(async (context) => {
    const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
    const headerRange: Excel.Range = sheet.getRange("B2:E2");
    const headerFont: Excel.RangeFont = headerRange.format.font;

    headerFont.load("bold, color, italic, name, size, underline");
    await context.sync();

    console.log(`Bold: ${headerFont.bold}`);
    console.log(`Color: ${headerFont.color}`);
    console.log(`Italic: ${headerFont.italic}`);
    console.log(`Name: ${headerFont.name}`);
    console.log(`Size: ${headerFont.size}`);
    console.log(`Underline: ${headerFont.underline}`);
});

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

Especifica o status itálico da fonte.

italic: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Nome da fonte (por exemplo, "Calibri"). O comprimento do nome não deve ser maior que 31 caracteres.

name: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

// Change the font of the selected range to "Impact".
await Excel.run(async (context) => {
  const selection = context.workbook.getSelectedRange();
  selection.format.font.name = "Impact";
  await context.sync();
});

Font Size

size: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Tipo de sublinhado aplicado à fonte. Consulte Excel.RangeUnderlineStyle para obter detalhes.

underline: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

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.RangeFontLoadOptions): Excel.RangeFont;

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

Parâmetros

Retornos

Exemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFont = range.format.font;
    rangeFont.load('name');
    await context.sync();
    console.log(rangeFont.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?: {
            select?: string;
            expand?: string;
        }): Excel.RangeFont;

Parâmetros

Retornos

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

Parâmetros

Retornos

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

set(properties: Excel.RangeFont): void;

Parâmetros

Retornos

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

toJSON(): Excel.Interfaces.RangeFontData;

Retornos