Excel.Style class
Um objeto que encapsula o formato de um estilo e outras propriedades.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.7]
Propriedades
| auto |
Especifica se o texto é recuado automaticamente quando o alinhamento do 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 ficará oculta quando a planilha estiver protegida. |
| horizontal |
Representa o alinhamento horizontal para o estilo. Consulte |
| include |
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. |
| include |
Especifica se o estilo inclui as propriedades de cor, índice de cor, estilo de linha e borda de espessura. |
| include |
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. |
| include |
Especifica se o estilo inclui a propriedade de formato de número. |
| include |
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. |
| include |
Especifica se o estilo inclui as propriedades de proteção oculta e bloqueada 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 é 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 é reduzido automaticamente para caber na largura de coluna disponível. |
| text |
A orientação de texto para o estilo. |
| vertical |
Especifica o alinhamento vertical do estilo. Consulte |
| wrap |
Especifica se o Excel quebra 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 do texto em uma célula é definido como distribuição igual.
autoIndent: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.8]
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
[Conjunto de apis: ExcelApi 1.7]
builtIn
Especifica se o estilo é um estilo interno.
readonly builtIn: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
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
[Conjunto de apis: ExcelApi 1.7]
font
Um Font objeto que representa a fonte do estilo.
readonly font: Excel.RangeFont;
Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.7]
formulaHidden
Especifica se a fórmula ficará oculta quando a planilha estiver protegida.
formulaHidden: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
horizontalAlignment
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
Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"
Comentários
[Conjunto de apis: ExcelApi 1.7]
includeAlignment
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
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
includeBorder
Especifica se o estilo inclui as propriedades de cor, índice de cor, estilo de linha e borda de espessura.
includeBorder: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
includeFont
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
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
includeNumber
Especifica se o estilo inclui a propriedade de formato de número.
includeNumber: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
includePatterns
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
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
includeProtection
Especifica se o estilo inclui as propriedades de proteção oculta e bloqueada da fórmula.
includeProtection: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: 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 apis: ExcelApi 1.7]
locked
Especifica se o objeto é bloqueado quando a planilha é protegida.
locked: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
name
O nome do estilo.
readonly name: string;
Valor da propriedade
string
Comentários
[Conjunto de apis: 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 apis: 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 apis: 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 apis: ExcelApi 1.7]
shrinkToFit
Especifica se o texto é reduzido automaticamente para caber na largura de coluna disponível.
shrinkToFit: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
textOrientation
A orientação de texto para o estilo.
textOrientation: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.8]
verticalAlignment
Especifica o alinhamento vertical do estilo. Consulte 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 apis: ExcelApi 1.7]
wrapText
Especifica se o Excel quebra o texto no objeto.
wrapText: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
Detalhes do método
delete()
Exclui este estilo.
delete(): void;
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.7]
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 devem ser carregadas.
Retornos
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írgula ou uma matriz de cadeias de caracteres que especifica 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írgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula 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 de propriedades tentar definir 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.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;