ExcelScript.RangeFont interface

Pacote:
ExcelScript

Esse objeto representa os atributos de fonte de um objeto, como nome, tamanho, cor, dentre outros.

Comentários

Usada por

Exemplos

/**
 * This script sets the font of A1 to Arial, size 16.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get A1 on the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Adjust the font settings for that cell.
  const cellFont = cell.getFormat().getFont();
  cellFont.setName("Arial");
  cellFont.setSize(16);
}

Métodos

getBold()

Representa o status de negrito da fonte.
getColor()

Representação da cor do texto no código de cores HTML (por exemplo, #FF0000 representa vermelho).
getItalic()

Especifica o status itálico da fonte.
getName()

Nome da fonte (por exemplo, "Calibri"). O comprimento do nome não deve ser maior que 31 caracteres.
getSize()

Font Size
getStrikethrough()

Especifica o status tachado da fonte. Um null valor indica que o intervalo inteiro não tem uma configuração de tachado uniforme.
getSubscript()

Especifica o status subscrito da fonte. Retorna true se todas as fontes do intervalo forem subscritas. Retorna false se todas as fontes do intervalo forem sobrescritas ou normais (nem sobrescrito nem subscrito). Retorna null caso contrário.
getSuperscript()

Especifica o status sobrescrito da fonte. Retorna true se todas as fontes do intervalo forem sobrescritos. Retorna false se todas as fontes do intervalo forem subscritas ou normais (nem sobrescrito nem subscrito). Retorna null caso contrário.
getTintAndShade()

Especifica um duplo que clareia ou escurece uma cor para a fonte do intervalo. O valor está entre -1 (mais escuro) e 1 (mais claro), com 0 para a cor original. Um null valor indica que o intervalo inteiro não tem uma configuração de fonte tintAndShade uniforme.
getUnderline()

Tipo de sublinhado aplicado à fonte. Consulte ExcelScript.RangeUnderlineStyle para obter detalhes.
setBold(bold)

Representa o status de negrito da fonte.
setColor(color)

Representação da cor do texto no código de cores HTML (por exemplo, #FF0000 representa vermelho).
setItalic(italic)

Especifica o status itálico da fonte.
setName(name)

Nome da fonte (por exemplo, "Calibri"). O comprimento do nome não deve ser maior que 31 caracteres.
setSize(size)

Font Size
setStrikethrough(strikethrough)

Especifica o status tachado da fonte. Um null valor indica que o intervalo inteiro não tem uma configuração de tachado uniforme.
setSubscript(subscript)

Especifica o status subscrito da fonte. Retorna true se todas as fontes do intervalo forem subscritas. Retorna false se todas as fontes do intervalo forem sobrescritas ou normais (nem sobrescrito nem subscrito). Retorna null caso contrário.
setSuperscript(superscript)

Especifica o status sobrescrito da fonte. Retorna true se todas as fontes do intervalo forem sobrescritos. Retorna false se todas as fontes do intervalo forem subscritas ou normais (nem sobrescrito nem subscrito). Retorna null caso contrário.
setTintAndShade(tintAndShade)

Especifica um duplo que clareia ou escurece uma cor para a fonte do intervalo. O valor está entre -1 (mais escuro) e 1 (mais claro), com 0 para a cor original. Um null valor indica que o intervalo inteiro não tem uma configuração de fonte tintAndShade uniforme.
setUnderline(underline)

Tipo de sublinhado aplicado à fonte. Consulte ExcelScript.RangeUnderlineStyle para obter detalhes.

Detalhes do método

getBold()

Representa o status de negrito da fonte.

getBold(): boolean;

Retornos

boolean

getColor()

Representação da cor do texto no código de cores HTML (por exemplo, #FF0000 representa vermelho).

getColor(): string;

Retornos

string

getItalic()

Especifica o status itálico da fonte.

getItalic(): boolean;

Retornos

boolean

getName()

Nome da fonte (por exemplo, "Calibri"). O comprimento do nome não deve ser maior que 31 caracteres.

getName(): string;

Retornos

string

getSize()

Font Size

getSize(): number;

Retornos

number

getStrikethrough()

Especifica o status tachado da fonte. Um null valor indica que o intervalo inteiro não tem uma configuração de tachado uniforme.

getStrikethrough(): boolean;

Retornos

boolean

getSubscript()

Especifica o status subscrito da fonte. Retorna true se todas as fontes do intervalo forem subscritas. Retorna false se todas as fontes do intervalo forem sobrescritas ou normais (nem sobrescrito nem subscrito). Retorna null caso contrário.

getSubscript(): boolean;

Retornos

boolean

getSuperscript()

Especifica o status sobrescrito da fonte. Retorna true se todas as fontes do intervalo forem sobrescritos. Retorna false se todas as fontes do intervalo forem subscritas ou normais (nem sobrescrito nem subscrito). Retorna null caso contrário.

getSuperscript(): boolean;

Retornos

boolean

getTintAndShade()

Especifica um duplo que clareia ou escurece uma cor para a fonte do intervalo. O valor está entre -1 (mais escuro) e 1 (mais claro), com 0 para a cor original. Um null valor indica que o intervalo inteiro não tem uma configuração de fonte tintAndShade uniforme.

getTintAndShade(): number;

Retornos

number

getUnderline()

Tipo de sublinhado aplicado à fonte. Consulte ExcelScript.RangeUnderlineStyle para obter detalhes.

getUnderline(): RangeUnderlineStyle;

Retornos

ExcelScript.RangeUnderlineStyle

setBold(bold)

Representa o status de negrito da fonte.

setBold(bold: boolean): void;

Parâmetros

bold

boolean

Retornos

void

Exemplos

/**
 * This script bolds the text of cell A1.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get A1 on the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Bold the font for that cell
  cell.getFormat().getFont().setBold(true);
}

setColor(color)

Representação da cor do texto no código de cores HTML (por exemplo, #FF0000 representa vermelho).

setColor(color: string): void;

Parâmetros

color

string

Retornos

void

setItalic(italic)

Especifica o status itálico da fonte.

setItalic(italic: boolean): void;

Parâmetros

italic

boolean

Retornos

void

setName(name)

Nome da fonte (por exemplo, "Calibri"). O comprimento do nome não deve ser maior que 31 caracteres.

setName(name: string): void;

Parâmetros

name

string

Retornos

void

Exemplos

/**
 * This script sets the font style of A1 to Arial.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get A1 on the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Adjust the font settings for that cell.
  cell.getFormat().getFont().setName("Arial");
}

setSize(size)

Font Size

setSize(size: number): void;

Parâmetros

size

number

Retornos

void

Exemplos

/**
 * This script sets the font size of A1 to 16.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get A1 on the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Adjust the font settings for that cell.clear
  cell.getFormat().getFont().setSize(16);
}

setStrikethrough(strikethrough)

Especifica o status tachado da fonte. Um null valor indica que o intervalo inteiro não tem uma configuração de tachado uniforme.

setStrikethrough(strikethrough: boolean): void;

Parâmetros

strikethrough

boolean

Retornos

void

setSubscript(subscript)

Especifica o status subscrito da fonte. Retorna true se todas as fontes do intervalo forem subscritas. Retorna false se todas as fontes do intervalo forem sobrescritas ou normais (nem sobrescrito nem subscrito). Retorna null caso contrário.

setSubscript(subscript: boolean): void;

Parâmetros

subscript

boolean

Retornos

void

setSuperscript(superscript)

Especifica o status sobrescrito da fonte. Retorna true se todas as fontes do intervalo forem sobrescritos. Retorna false se todas as fontes do intervalo forem subscritas ou normais (nem sobrescrito nem subscrito). Retorna null caso contrário.

setSuperscript(superscript: boolean): void;

Parâmetros

superscript

boolean

Retornos

void

setTintAndShade(tintAndShade)

Especifica um duplo que clareia ou escurece uma cor para a fonte do intervalo. O valor está entre -1 (mais escuro) e 1 (mais claro), com 0 para a cor original. Um null valor indica que o intervalo inteiro não tem uma configuração de fonte tintAndShade uniforme.

setTintAndShade(tintAndShade: number): void;

Parâmetros

tintAndShade

number

Retornos

void

setUnderline(underline)

Tipo de sublinhado aplicado à fonte. Consulte ExcelScript.RangeUnderlineStyle para obter detalhes.

setUnderline(underline: RangeUnderlineStyle): void;

Parâmetros

underline
ExcelScript.RangeUnderlineStyle

Retornos

void