Compartilhar via

Excel.Style class

  • Referência
Pacote:
excel

Um objeto que encapsula o formato de um estilo e outras propriedades.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Propriedades

autoIndent

Especifica se o texto é automaticamente avanço quando o alinhamento do texto numa célula é definido como distribuição igual.
borders

Uma coleção de quatro objetos de limite que representam o estilo dos quatro limites.
builtIn

Especifica se o estilo é um estilo incorporado.
context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
fill

O preenchimento do estilo.
font

Um Font objeto que representa o tipo de letra do estilo.
formulaHidden

Especifica se a fórmula será ocultada quando a folha de cálculo estiver protegida.
horizontalAlignment

Representa o alinhamento horizontal para o estilo. Veja Excel.HorizontalAlignment para obter detalhes.
includeAlignment

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

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

Especifica se o estilo inclui as propriedades de fundo, negrito, cor, índice de cores, estilo do tipo de letra, itálico, nome, tamanho, rasurado, inferior à linha, superior à linha e sublinhado.
includeNumber

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

Especifica se o estilo inclui a cor, o índice de cores, inverter se negativo, padrão, cor do padrão e propriedades interiores do índice de cores do padrão.
includeProtection

Especifica se o estilo inclui as propriedades de proteção ocultas e bloqueadas da fórmula.
indentLevel

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

Especifica se o objeto está bloqueado quando a folha de cálculo está protegida.
name

O nome do estilo.
numberFormat

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

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

A ordem de leitura para o estilo.
shrinkToFit

Especifica se o texto diminui automaticamente para caber na largura da coluna disponível.
textOrientation

A orientação de texto para o estilo.
verticalAlignment

Especifica o alinhamento vertical para o estilo. Veja Excel.VerticalAlignment para obter detalhes.
wrapText

Especifica se o Excel molda o texto no objeto.

Métodos

delete()

Exclui este estilo.
load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
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(propertyNamesAndPaths)

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

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Excel.Style original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.StyleData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

autoIndent

Especifica se o texto é automaticamente avanço quando o alinhamento do texto numa célula é definido como distribuição igual.

autoIndent: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

borders

Uma coleção de quatro objetos de limite que representam o estilo dos quatro limites.

readonly borders: Excel.RangeBorderCollection;

Valor da propriedade

Excel.RangeBorderCollection

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

builtIn

Especifica se o estilo é um estilo incorporado.

readonly builtIn: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

fill

O preenchimento do estilo.

readonly fill: Excel.RangeFill;

Valor da propriedade

Excel.RangeFill

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

font

Um Font objeto que representa o tipo de letra do estilo.

readonly font: Excel.RangeFont;

Valor da propriedade

Excel.RangeFont

Comentários

[ Conjunto de API: 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);
});

formulaHidden

Especifica se a fórmula será ocultada quando a folha de cálculo estiver protegida.

formulaHidden: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

horizontalAlignment

Representa o alinhamento horizontal para o estilo. Veja Excel.HorizontalAlignment para obter detalhes.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: 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();
});

includeAlignment

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

includeAlignment: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

includeBorder

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

includeBorder: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

includeFont

Especifica se o estilo inclui as propriedades de fundo, negrito, cor, índice de cores, estilo do tipo de letra, itálico, nome, tamanho, rasurado, inferior à linha, superior à linha e sublinhado.

includeFont: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

includeNumber

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

includeNumber: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

includePatterns

Especifica se o estilo inclui a cor, o índice de cores, inverter se negativo, padrão, cor do padrão e propriedades interiores do índice de cores do padrão.

includePatterns: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

includeProtection

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

includeProtection: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

indentLevel

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

indentLevel: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

locked

Especifica se o objeto está bloqueado quando a folha de cálculo está protegida.

locked: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

name

O nome do estilo.

readonly name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

numberFormat

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

numberFormat: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

numberFormatLocal

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

numberFormatLocal: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

readingOrder

A ordem de leitura para o estilo.

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

Valor da propriedade

Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

shrinkToFit

Especifica se o texto diminui automaticamente para caber na largura da coluna disponível.

shrinkToFit: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

textOrientation

A orientação de texto para o estilo.

textOrientation: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

verticalAlignment

Especifica o alinhamento vertical para o estilo. Veja Excel.VerticalAlignment para obter detalhes.

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

Valor da propriedade

Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

wrapText

Especifica se o Excel molda o texto no objeto.

wrapText: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Detalhes do método

delete()

Exclui este estilo.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: 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.");
});

load(options)

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

options
Excel.Interfaces.StyleLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.Style

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);
});

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.Style

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Excel.Style

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.StyleUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

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

set(properties: Excel.Style): void;

Parâmetros

properties
Excel.Style

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Excel.Style original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.StyleData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.StyleData;

Retornos

Excel.Interfaces.StyleData