Excel.RangeFont class
Esse objeto representa os atributos de fonte de um objeto, como nome, tamanho, cor, dentre outros.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
| bold | Representa o estado de negrito do tipo de letra. |
| color | Representação do código de cores HTML da cor do texto (por exemplo, #FF0000 representa Vermelho). |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| italic | Especifica o estado itálico do tipo de letra. |
| name | Nome do tipo de letra (por exemplo, "Calibri"). O comprimento do nome não deve ser superior a 31 carateres. |
| size | Font Size |
| strikethrough | Especifica o estado de rasurado do tipo de letra. Um |
| subscript | Especifica o estado inferior à linha do tipo de letra. Devolve |
| superscript | Especifica o estado superior à linha do tipo de letra. Devolve |
| tint |
Especifica um duplo que ilumina ou escurece uma cor para o tipo de letra do intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um |
| underline | Tipo de sublinhado aplicado à fonte. Veja |
Métodos
| 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. 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 |
Detalhes da propriedade
bold
Representa o estado de negrito do tipo de letra.
bold: boolean;Valor da propriedade
boolean
Comentários
color
Representação do código de cores HTML da cor do texto (por exemplo, #FF0000 representa Vermelho).
color: string;Valor da propriedade
string
Comentários
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
italic
Especifica o estado itálico do tipo de letra.
italic: boolean;Valor da propriedade
boolean
Comentários
name
Nome do tipo de letra (por exemplo, "Calibri"). O comprimento do nome não deve ser superior a 31 carateres.
name: string;Valor da propriedade
string
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
// Change the font of the selected range to "Impact".
await Excel.run(async (context) => {
const selection = context.workbook.getSelectedRange();
selection.format.font.name = "Impact";
await context.sync();
});
size
strikethrough
Especifica o estado de rasurado do tipo de letra. Um null valor indica que todo o intervalo não tem uma definição de rasurado uniforme.
strikethrough: boolean;Valor da propriedade
boolean
Comentários
subscript
Especifica o estado inferior à linha do tipo de letra. Devolve true se todos os tipos de letra do intervalo forem inferior à linha. Devolve false se todos os tipos de letra do intervalo forem superiores ou normais (nem superior à linha nem inferior à linha). Devolve null o contrário.
subscript: boolean;Valor da propriedade
boolean
Comentários
superscript
Especifica o estado superior à linha do tipo de letra. Devolve true se todos os tipos de letra do intervalo forem superiores à linha. Devolve false se todos os tipos de letra do intervalo forem inferiores à linha ou normais (nem superior à linha nem inferior à linha). Devolve null o contrário.
superscript: boolean;Valor da propriedade
boolean
Comentários
tintAndShade
Especifica um duplo que ilumina ou escurece uma cor para o tipo de letra do intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que todo o intervalo não tem uma definição de tipo de letra tintAndShade uniforme.
tintAndShade: number;Valor da propriedade
number
Comentários
underline
Tipo de sublinhado aplicado à fonte. Veja Excel.RangeUnderlineStyle para obter detalhes.
underline: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";Valor da propriedade
Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"
Comentários
Detalhes do método
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.RangeFontLoadOptions): Excel.RangeFont;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
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.RangeFont;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
Exemplos
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "F:G";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
const rangeFont = range.format.font;
rangeFont.load('name');
await context.sync();
console.log(rangeFont.name);
});
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.RangeFont;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
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.RangeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.RangeFontUpdateData
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.RangeFont): void;Parâmetros
- properties
- Excel.RangeFont
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.RangeFont original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.RangeFontData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.RangeFontData;