ExcelScript.RangeFont interface

Pacote:

ExcelScript

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

Comentários

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 a status a negrito do tipo de letra.
getColor()	Representação do código de cores HTML da cor do texto (por exemplo, #FF0000 representa Vermelho).
getItalic()	Especifica o status itálico do tipo de letra.
getName()	Nome do tipo de letra (por exemplo, "Calibri"). O comprimento do nome não deve ser superior a 31 carateres.
getSize()	Font Size
getStrikethrough()	Especifica a status rasurado do tipo de letra. Um null valor indica que todo o intervalo não tem uma definição de rasurado uniforme.
getSubscript()	Especifica a status 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.
getSuperscript()	Especifica a status 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.
getTintAndShade()	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.
getUnderline()	Tipo de sublinhado aplicado à fonte. Veja ExcelScript.RangeUnderlineStyle para obter detalhes.
setBold(bold)	Representa a status a negrito do tipo de letra.
setColor(color)	Representação do código de cores HTML da cor do texto (por exemplo, #FF0000 representa Vermelho).
setItalic(italic)	Especifica o status itálico do tipo de letra.
setName(name)	Nome do tipo de letra (por exemplo, "Calibri"). O comprimento do nome não deve ser superior a 31 carateres.
setSize(size)	Font Size
setStrikethrough(strikethrough)	Especifica a status rasurado do tipo de letra. Um null valor indica que todo o intervalo não tem uma definição de rasurado uniforme.
setSubscript(subscript)	Especifica a status 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.
setSuperscript(superscript)	Especifica a status 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.
setTintAndShade(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.
setUnderline(underline)	Tipo de sublinhado aplicado à fonte. Veja ExcelScript.RangeUnderlineStyle para obter detalhes.

Detalhes do método

getBold()

Representa a status a negrito do tipo de letra.

getBold(): boolean;

Retornos

boolean

getColor()

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

getColor(): string;

Retornos

string

getItalic()

Especifica o status itálico do tipo de letra.

getItalic(): boolean;

Retornos

boolean

getName()

Nome do tipo de letra (por exemplo, "Calibri"). O comprimento do nome não deve ser superior a 31 carateres.

getName(): string;

Retornos

string

getSize()

Font Size

getSize(): number;

Retornos

number

getStrikethrough()

Especifica a status rasurado do tipo de letra. Um null valor indica que todo o intervalo não tem uma definição de rasurado uniforme.

getStrikethrough(): boolean;

Retornos

boolean

getSubscript()

Especifica a status 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.

getSubscript(): boolean;

Retornos

boolean

getSuperscript()

Especifica a status 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.

getSuperscript(): boolean;

Retornos

boolean

getTintAndShade()

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.

getTintAndShade(): number;

Retornos

number

getUnderline()

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

getUnderline(): RangeUnderlineStyle;

Retornos

ExcelScript.RangeUnderlineStyle

setBold(bold)

Representa a status a negrito do tipo de letra.

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 do código de cores HTML da cor do texto (por exemplo, #FF0000 representa Vermelho).

setColor(color: string): void;

Parâmetros

color

string

Retornos

void

setItalic(italic)

Especifica o status itálico do tipo de letra.

setItalic(italic: boolean): void;

Parâmetros

italic

boolean

Retornos

void

setName(name)

Nome do tipo de letra (por exemplo, "Calibri"). O comprimento do nome não deve ser superior a 31 carateres.

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 a status rasurado do tipo de letra. Um null valor indica que todo o intervalo não tem uma definição de rasurado uniforme.

setStrikethrough(strikethrough: boolean): void;

Parâmetros

strikethrough

boolean

Retornos

void

setSubscript(subscript)

Especifica a status 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.

setSubscript(subscript: boolean): void;

Parâmetros

subscript

boolean

Retornos

void

setSuperscript(superscript)

Especifica a status 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.

setSuperscript(superscript: boolean): void;

Parâmetros

superscript

boolean

Retornos

void

setTintAndShade(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.

setTintAndShade(tintAndShade: number): void;

Parâmetros

tintAndShade

number

Retornos

void

setUnderline(underline)

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

setUnderline(underline: RangeUnderlineStyle): void;

Parâmetros

underline

ExcelScript.RangeUnderlineStyle

Retornos

void