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 status em negrito da fonte. |
| color | Representação de código de cor HTML da cor do texto (por exemplo, #FF0000 representa Vermelho). |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| italic | Especifica o status itálico da fonte. |
| name | Nome da fonte (por exemplo, "Calibri"). O comprimento do nome não deve ser maior que 31 caracteres. |
| size | Font Size |
| strikethrough | Especifica o status de strikethrough da fonte. Um |
| subscript | Especifica o status de subscrição da fonte. Retornará |
| superscript | Especifica o status superscript da fonte. Retornará |
| tint |
Especifica um duplo que clareia ou escure uma cor para a fonte de intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um |
| underline | Tipo de sublinhado aplicado à fonte. Confira |
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. 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
bold
Representa o status em negrito da fonte.
bold: boolean;Valor da propriedade
boolean
Comentários
color
Representação de código de cor HTML da cor do texto (por exemplo, #FF0000 representa Vermelho).
color: string;Valor da propriedade
string
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
italic
Especifica o status itálico da fonte.
italic: boolean;Valor da propriedade
boolean
Comentários
name
Nome da fonte (por exemplo, "Calibri"). O comprimento do nome não deve ser maior que 31 caracteres.
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 status de strikethrough da fonte. Um null valor indica que todo o intervalo não tem uma configuração de strikethrough uniforme.
strikethrough: boolean;Valor da propriedade
boolean
Comentários
subscript
Especifica o status de subscrição da fonte. Retornará true se todas as fontes do intervalo forem subscript. Retorna false se todas as fontes do intervalo forem superscript ou normais (nem superscript nem subscript). Retorna null caso contrário.
subscript: boolean;Valor da propriedade
boolean
Comentários
superscript
Especifica o status superscript da fonte. Retornará true se todas as fontes do intervalo forem superscript. Retornará false se todas as fontes do intervalo forem subscritos ou normais (nem superscript nem subscript). Retorna null caso contrário.
superscript: boolean;Valor da propriedade
boolean
Comentários
tintAndShade
Especifica um duplo que clareia ou escure uma cor para a fonte de 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 configuração de fonte tintAndShade uniforme.
tintAndShade: number;Valor da propriedade
number
Comentários
underline
Tipo de sublinhado aplicado à fonte. Confira Excel.RangeUnderlineStyle 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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
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 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.RangeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.RangeFontUpdateData
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.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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.RangeFont original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.RangeFontData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.RangeFontData;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