Excel.Style class

Especifica se o texto é recuado automaticamente quando o alinhamento do texto em uma célula é definido como distribuição igual.

autoIndent: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.8

Uma coleção de quatro objetos de borda que representam o estilo das quatro bordas.

readonly borders: Excel.RangeBorderCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Especifica se o estilo é um estilo interno.

readonly builtIn: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

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

O preenchimento do estilo.

readonly fill: Excel.RangeFill;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Um Font objeto que representa a fonte do estilo.

readonly font: Excel.RangeFont;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

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 style = context.workbook.styles.getItem("Normal");
    style.font.load("bold, color, italic, name, size");
    style.fill.load("color");

    await context.sync();

    console.log("Bold: " + style.font.bold);
    console.log("Font color: " + style.font.color);
    console.log("Italic: " + style.font.italic);
    console.log("Name: " + style.font.name);
    console.log("Size: " + style.font.size);
    console.log("Fill color: " + style.fill.color);
});

Especifica se a fórmula ficará oculta quando a planilha estiver protegida.

formulaHidden: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Representa o alinhamento horizontal para o estilo. 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.7

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 built-in style. 
    // Styles are in the Home tab ribbon.
    range.style = Excel.BuiltInStyle.neutral;
    range.format.horizontalAlignment = "Right";

    await context.sync();
});

Especifica se o estilo inclui as propriedades recuo automático, alinhamento horizontal, alinhamento vertical, quebra automática de texto, nível de recuo e orientação do texto.

includeAlignment: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Especifica se o estilo inclui as propriedades de cor, índice de cor, estilo de linha e borda de espessura.

includeBorder: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Especifica se o estilo inclui as propriedades de fonte plano de fundo, negrito, cor, índice de cores, estilo da fonte, itálico, nome, tamanho, tachado, subscrito, sobrescrito e sublinhado.

includeFont: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Especifica se o estilo inclui a propriedade de formato de número.

includeNumber: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Especifica se o estilo inclui as propriedades cor, índice de cor, inverter se negativo, padrão, cor padrão e índice de cor padrão.

includePatterns: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Especifica se o estilo inclui as propriedades de proteção oculta e bloqueada da fórmula.

includeProtection: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Um número inteiro entre 0 e 250 que indica o nível de recuo do estilo.

indentLevel: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Especifica se o objeto é bloqueado quando a planilha é protegida.

locked: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

O nome do estilo.

readonly name: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

O código de formatação de formato de número para o estilo.

numberFormat: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

O código de formato localizado do formato numérico para o estilo.

numberFormatLocal: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

A ordem de leitura para o estilo.

readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Especifica se o texto é reduzido automaticamente para caber na largura de coluna disponível.

shrinkToFit: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

A orientação de texto para o estilo.

textOrientation: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.8

Especifica o alinhamento vertical do estilo. Consulte Excel.VerticalAlignment para obter detalhes.

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

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Especifica se o Excel quebra o texto no objeto.

wrapText: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Exclui este estilo.

delete(): void;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.7

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 style = context.workbook.styles.getItem("Diagonal Orientation Style");

    // Delete the diagonal orientation style from the style collection.
    // Styles are in the Home tab ribbon.
    style.delete();

    await context.sync();

    console.log("Successfully deleted the diagonal orientation style from the Home tab ribbon.");
});

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.StyleLoadOptions): Excel.Style;

Parâmetros

Retornos

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 style = context.workbook.styles.getItem("Diagonal Orientation Style");            
    style.load("textOrientation, horizontalAlignment, autoIndent, readingOrder, wrapText, includeProtection, shrinkToFit, locked");

    await context.sync();

    console.log("Orientation: " + style.textOrientation);
    console.log("Horizontal alignment: " + style.horizontalAlignment);
    console.log("Add indent: " + style.autoIndent);
    console.log("Reading order: " + style.readingOrder);
    console.log("Wrap text: " + style.wrapText);
    console.log("Include protection: " + style.includeProtection);
    console.log("Shrink to fit: " + style.shrinkToFit);
    console.log("Style locked: " + style.locked);
});

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

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(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Style;

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

toJSON(): Excel.Interfaces.StyleData;

Retornos