Excel.Style class
Um objeto encapsulando o formato de um estilo e outras propriedades.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Propriedades
| auto |
Especifica se o texto é recuado automaticamente quando o alinhamento de texto em uma célula é definido como distribuição igual. |
| borders | Uma coleção de quatro objetos de borda que representam o estilo das quatro bordas. |
| built |
Especifica se o estilo é um estilo interno. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| fill | O preenchimento do estilo. |
| font | Um |
| formula |
Especifica se a fórmula será ocultada quando a planilha estiver protegida. |
| horizontal |
Representa o alinhamento horizontal para o estilo. Confira |
| include |
Especifica se o estilo inclui as propriedades de recuo automático, alinhamento horizontal, alinhamento vertical, texto de envoltório, nível de recuo e orientação de texto. |
| include |
Especifica se o estilo inclui as propriedades color, color index, line style e weight border. |
| include |
Especifica se o estilo inclui as propriedades de fonte em segundo plano, negrito, cor, índice de cores, estilo de fonte, itálico, nome, tamanho, strikethrough, subscript, superscript e sublinhar as propriedades da fonte. |
| include |
Especifica se o estilo inclui a propriedade de formato de número. |
| include |
Especifica se o estilo inclui as propriedades interiores color, color index, invert if negative, pattern, pattern color e pattern color index. |
| include |
Especifica se o estilo inclui as propriedades de proteção ocultas e bloqueadas da fórmula. |
| indent |
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 planilha é protegida. |
| name | O nome do estilo. |
| number |
O código de formatação de formato de número para o estilo. |
| number |
O código de formato localizado do formato numérico para o estilo. |
| reading |
A ordem de leitura para o estilo. |
| shrink |
Especifica se o texto reduz automaticamente para se encaixar na largura da coluna disponível. |
| text |
A orientação de texto para o estilo. |
| vertical |
Especifica o alinhamento vertical para o estilo. Confira |
| wrap |
Especifica se o Excel encapsula 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 |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | 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) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
autoIndent
Especifica se o texto é recuado automaticamente quando o alinhamento de texto em uma célula é definido como distribuição igual.
autoIndent: boolean;Valor da propriedade
boolean
Comentários
borders
Uma coleção de quatro objetos de borda que representam o estilo das quatro bordas.
readonly borders: Excel.RangeBorderCollection;Valor da propriedade
Comentários
builtIn
Especifica se o estilo é um estilo interno.
readonly builtIn: boolean;Valor da propriedade
boolean
Comentários
context
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
fill
O preenchimento do estilo.
readonly fill: Excel.RangeFill;Valor da propriedade
Comentários
font
Um Font objeto que representa a fonte do estilo.
readonly font: Excel.RangeFont;Valor da propriedade
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 planilha estiver protegida.
formulaHidden: boolean;Valor da propriedade
boolean
Comentários
horizontalAlignment
Representa o alinhamento horizontal para o estilo. Confira Excel.HorizontalAlignment 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 de recuo automático, alinhamento horizontal, alinhamento vertical, texto de envoltório, nível de recuo e orientação de texto.
includeAlignment: boolean;Valor da propriedade
boolean
Comentários
includeBorder
Especifica se o estilo inclui as propriedades color, color index, line style e weight border.
includeBorder: boolean;Valor da propriedade
boolean
Comentários
includeFont
Especifica se o estilo inclui as propriedades de fonte em segundo plano, negrito, cor, índice de cores, estilo de fonte, itálico, nome, tamanho, strikethrough, subscript, superscript e sublinhar as propriedades da fonte.
includeFont: boolean;Valor da propriedade
boolean
Comentários
includeNumber
Especifica se o estilo inclui a propriedade de formato de número.
includeNumber: boolean;Valor da propriedade
boolean
Comentários
includePatterns
Especifica se o estilo inclui as propriedades interiores color, color index, invert if negative, pattern, pattern color e pattern color index.
includePatterns: boolean;Valor da propriedade
boolean
Comentários
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
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
locked
Especifica se o objeto está bloqueado quando a planilha é protegida.
locked: boolean;Valor da propriedade
boolean
Comentários
name
O nome do estilo.
readonly name: string;Valor da propriedade
string
Comentários
numberFormat
O código de formatação de formato de número para o estilo.
numberFormat: string;Valor da propriedade
string
Comentários
numberFormatLocal
O código de formato localizado do formato numérico para o estilo.
numberFormatLocal: string;Valor da propriedade
string
Comentários
readingOrder
A ordem de leitura para o estilo.
readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";Valor da propriedade
Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"
Comentários
shrinkToFit
Especifica se o texto reduz automaticamente para se encaixar na largura da coluna disponível.
shrinkToFit: boolean;Valor da propriedade
boolean
Comentários
textOrientation
A orientação de texto para o estilo.
textOrientation: number;Valor da propriedade
number
Comentários
verticalAlignment
Especifica o alinhamento vertical para o estilo. Confira Excel.VerticalAlignment detalhes.
verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";Valor da propriedade
Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"
Comentários
wrapText
Especifica se o Excel encapsula o texto no objeto.
wrapText: boolean;Valor da propriedade
boolean
Comentários
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
Fornece opções para quais propriedades do objeto carregar.
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);
});
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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
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
- properties
- Excel.Interfaces.StyleUpdateData
Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.Style original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.StyleData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.StyleData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de