Excel.RangeFormat class

Coleção de objetos border que se aplicam a todo o intervalo.

readonly borders: Excel.RangeBorderCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Especifica a largura de todas as colunas dentro do intervalo. Se as larguras das colunas não forem uniformes, null será retornado.

columnWidth: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.2

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

Retorna o objeto de preenchimento definido em todo o intervalo.

readonly fill: Excel.RangeFill;

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

// Set the fill color 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");

    headerRange.format.fill.color = "#D9EAF7";

    await context.sync();
    console.log("The header fill color was updated.");
});

Retorna o objeto font definido em todo o intervalo.

readonly font: Excel.RangeFont;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Representa o alinhamento horizontal do objeto especificado. Consulte Excel.HorizontalAlignment para obter detalhes.

horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";

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/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Set a default value for an empty cell in the PivotTable. This doesn't include cells left blank by the layout.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.emptyCellText = "--";

  // Set the text alignment to match the rest of the PivotTable.
  pivotLayout.getDataBodyRange().format.horizontalAlignment = Excel.HorizontalAlignment.right;
  await context.sync();
});

Retorna o objeto de proteção de formato para um intervalo.

readonly protection: Excel.FormatProtection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.2

A altura de todas as linhas no intervalo. Se as alturas da linha não forem uniformes, null será retornado.

rowHeight: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.2

Representa o alinhamento vertical do objeto especificado. Consulte Excel.VerticalAlignment para obter detalhes.

verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";

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/style.yaml

await Excel.run(async (context) => {
    let worksheet = context.workbook.worksheets.getItem("Sample");
    let range = worksheet.getRange("A1:E1");
    // Apply new style.
    range.style = ("Diagonal Orientation Style");
    range.format.verticalAlignment = "Justify";

    await context.sync();
});

Especifica se o Excel quebra o texto no objeto. Um null valor indica que o intervalo inteiro não tem uma configuração de disposição uniforme

wrapText: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Altera a largura das colunas do intervalo atual para obter o melhor ajuste, com base nos dados atuais nas colunas.

autofitColumns(): void;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.2

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let range = sheet.getRange("B7");
    range.values = [[900]];
    range.format.autofitColumns();

    await context.sync();
    console.log("B7 value has been changed.");
});

Altera a altura das linhas do intervalo atual para obter o melhor ajuste, com base nos dados atuais nas colunas.

autofitRows(): void;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.2

Exemplos

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

function queueCommandsToCreateTemperatureTable(sheet: Excel.Worksheet) {
    let temperatureTable = sheet.tables.add('A1:M1', true);
    temperatureTable.name = "TemperatureTable";
    temperatureTable.getHeaderRowRange().values = [["Category", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]];
    temperatureTable.rows.add(null, [
        ["Avg High", 40, 38, 44, 45, 51, 56, 67, 72, 79, 59, 45, 41],
        ["Avg Low", 34, 33, 38, 41, 45, 48, 51, 55, 54, 45, 41, 38],
        ["Record High", 61, 69, 79, 83, 95, 97, 100, 101, 94, 87, 72, 66],
        ["Record Low", -1, 2, 9, 24, 28, 32, 36, 39, 35, 21, 12, 4]
    ]);
    temperatureTable.getRange().format.autofitColumns();
    temperatureTable.getRange().format.autofitRows();
}

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.RangeFormatLoadOptions): Excel.RangeFormat;

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

Parâmetros

Retornos

Exemplos

// Select all of the range's format properties.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load(["format/*", "format/fill", "format/borders", "format/font"]);
    await context.sync();
    
    console.log(range.format.wrapText);
    console.log(range.format.fill.color);
    console.log(range.format.font.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.RangeFormat;

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

toJSON(): Excel.Interfaces.RangeFormatData;

Retornos