ExcelScript.RangeFont interface

包:

ExcelScript

此对象表示对象的字体属性（字体名称、字体大小、颜色等）。

注解

示例

/**
 * 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);
}

方法

getBold()	表示字体的粗体状态。
getColor()	文本颜色 (的 HTML 颜色代码表示形式，例如，#FF0000 表示红色) 。
getItalic()	指定字体的斜体状态。
getName()	字体名称 (，例如“Calibri”) 。 名称的长度不应大于 31 个字符。
getSize()	字号
getStrikethrough()	指定字体的删除线状态。 值 null 指示整个范围没有统一删除线设置。
getSubscript()	指定字体的下标状态。 true如果区域的所有字体均为下标，则返回 。 false如果区域的所有字体均为上标或普通 (既不是上标，也不是下标) ，则返回 。 否则返回 null 。
getSuperscript()	指定字体的上标状态。 true如果区域的所有字体均为上标，则返回 。 false如果区域的所有字体都是下标或普通 (既不是上标，也不是下标) ，则返回 。 否则返回 null 。
getTintAndShade()	指定使范围字体的颜色变浅或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 值 null 指示整个区域没有统一的字体 tintAndShade 设置。
getUnderline()	应用于字体的下划线类型。 有关详细信息，请参阅 ExcelScript.RangeUnderlineStyle。
setBold(bold)	表示字体的粗体状态。
setColor(color)	文本颜色 (的 HTML 颜色代码表示形式，例如，#FF0000 表示红色) 。
setItalic(italic)	指定字体的斜体状态。
setName(name)	字体名称 (，例如“Calibri”) 。 名称的长度不应大于 31 个字符。
setSize(size)	字号
setStrikethrough(strikethrough)	指定字体的删除线状态。 值 null 指示整个范围没有统一删除线设置。
setSubscript(subscript)	指定字体的下标状态。 true如果区域的所有字体均为下标，则返回 。 false如果区域的所有字体均为上标或普通 (既不是上标，也不是下标) ，则返回 。 否则返回 null 。
setSuperscript(superscript)	指定字体的上标状态。 true如果区域的所有字体均为上标，则返回 。 false如果区域的所有字体都是下标或普通 (既不是上标，也不是下标) ，则返回 。 否则返回 null 。
setTintAndShade(tintAndShade)	指定使范围字体的颜色变浅或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 值 null 指示整个区域没有统一的字体 tintAndShade 设置。
setUnderline(underline)	应用于字体的下划线类型。 有关详细信息，请参阅 ExcelScript.RangeUnderlineStyle。

方法详细信息

getBold()

表示字体的粗体状态。

getBold(): boolean;

返回

boolean

getColor()

文本颜色 (的 HTML 颜色代码表示形式，例如，#FF0000 表示红色) 。

getColor(): string;

返回

string

getItalic()

指定字体的斜体状态。

getItalic(): boolean;

返回

boolean

getName()

字体名称 (，例如“Calibri”) 。 名称的长度不应大于 31 个字符。

getName(): string;

返回

string

getSize()

字号

getSize(): number;

返回

number

getStrikethrough()

指定字体的删除线状态。 值 null 指示整个范围没有统一删除线设置。

getStrikethrough(): boolean;

返回

boolean

getSubscript()

指定字体的下标状态。 true如果区域的所有字体均为下标，则返回 。 false如果区域的所有字体均为上标或普通 (既不是上标，也不是下标) ，则返回 。 否则返回 null 。

getSubscript(): boolean;

返回

boolean

getSuperscript()

指定字体的上标状态。 true如果区域的所有字体均为上标，则返回 。 false如果区域的所有字体都是下标或普通 (既不是上标，也不是下标) ，则返回 。 否则返回 null 。

getSuperscript(): boolean;

返回

boolean

getTintAndShade()

指定使范围字体的颜色变浅或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 值 null 指示整个区域没有统一的字体 tintAndShade 设置。

getTintAndShade(): number;

返回

number

getUnderline()

应用于字体的下划线类型。 有关详细信息，请参阅 ExcelScript.RangeUnderlineStyle。

getUnderline(): RangeUnderlineStyle;

返回

ExcelScript.RangeUnderlineStyle

setBold(bold)

表示字体的粗体状态。

setBold(bold: boolean): void;

参数

bold

boolean

返回

void

示例

/**
 * 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)

文本颜色 (的 HTML 颜色代码表示形式，例如，#FF0000 表示红色) 。

setColor(color: string): void;

参数

color

string

返回

void

setItalic(italic)

指定字体的斜体状态。

setItalic(italic: boolean): void;

参数

italic

boolean

返回

void

setName(name)

字体名称 (，例如“Calibri”) 。 名称的长度不应大于 31 个字符。

setName(name: string): void;

参数

name

string

返回

void

示例

/**
 * 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)

字号

setSize(size: number): void;

参数

size

number

返回

void

示例

/**
 * 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)

指定字体的删除线状态。 值 null 指示整个范围没有统一删除线设置。

setStrikethrough(strikethrough: boolean): void;

参数

strikethrough

boolean

返回

void

setSubscript(subscript)

指定字体的下标状态。 true如果区域的所有字体均为下标，则返回 。 false如果区域的所有字体均为上标或普通 (既不是上标，也不是下标) ，则返回 。 否则返回 null 。

setSubscript(subscript: boolean): void;

参数

subscript

boolean

返回

void

setSuperscript(superscript)

指定字体的上标状态。 true如果区域的所有字体均为上标，则返回 。 false如果区域的所有字体都是下标或普通 (既不是上标，也不是下标) ，则返回 。 否则返回 null 。

setSuperscript(superscript: boolean): void;

参数

superscript

boolean

返回

void

setTintAndShade(tintAndShade)

指定使范围字体的颜色变浅或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 值 null 指示整个区域没有统一的字体 tintAndShade 设置。

setTintAndShade(tintAndShade: number): void;

参数

tintAndShade

number

返回

void

setUnderline(underline)

应用于字体的下划线类型。 有关详细信息，请参阅 ExcelScript.RangeUnderlineStyle。

setUnderline(underline: RangeUnderlineStyle): void;

参数

underline

ExcelScript.RangeUnderlineStyle

返回

void