ExcelScript.ShapeFont interface

表示形状 TextRange 对象的字体属性,例如字体名称、字号和颜色。

注解

示例

/**
 * This sample sets the font of a shape to be bold. 
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first shape in the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const shape = sheet.getShapes()[0];

  // Get the text font from the shape.
  const text: ExcelScript.TextRange = shape.getTextFrame().getTextRange();
  const shapeTextFont: ExcelScript.ShapeFont = text.getFont();

  // Set the font to be bold.
  shapeTextFont.setBold(true);
}

方法

getBold()

表示字体的加粗状态。 null如果 TextRange 同时包含加粗和非粗体文本片段,则返回 。

getColor()

文本颜色 (的 HTML 颜色代码表示形式,例如,“#FF0000”表示红色) 。 null如果 TextRange 包含不同颜色的文本片段,则返回 。

getItalic()

表示字体的斜体状态。 null如果 TextRange 同时包含斜体和非斜体文本片段,则返回 。

getName()

表示字体名称 (例如“Calibri”) 。 如果文本是复杂脚本或东亚语言,则这是相应的字体名称:否则为拉丁文字体名称。

getSize()

以磅为单位表示字号 (,例如 11) 。 null如果 TextRange 包含具有不同字号的文本片段,则返回 。

getUnderline()

应用于字体的下划线类型。 null如果 TextRange 包含具有不同下划线样式的文本片段,则返回 。 有关详细信息,请参阅 ExcelScript.ShapeFontUnderlineStyle

setBold(bold)

表示字体的加粗状态。 null如果 TextRange 同时包含加粗和非粗体文本片段,则返回 。

setColor(color)

文本颜色 (的 HTML 颜色代码表示形式,例如,“#FF0000”表示红色) 。 null如果 TextRange 包含不同颜色的文本片段,则返回 。

setItalic(italic)

表示字体的斜体状态。 null如果 TextRange 同时包含斜体和非斜体文本片段,则返回 。

setName(name)

表示字体名称 (例如“Calibri”) 。 如果文本是复杂脚本或东亚语言,则这是相应的字体名称:否则为拉丁文字体名称。

setSize(size)

以磅为单位表示字号 (,例如 11) 。 null如果 TextRange 包含具有不同字号的文本片段,则返回 。

setUnderline(underline)

应用于字体的下划线类型。 null如果 TextRange 包含具有不同下划线样式的文本片段,则返回 。 有关详细信息,请参阅 ExcelScript.ShapeFontUnderlineStyle

方法详细信息

getBold()

表示字体的加粗状态。 null如果 TextRange 同时包含加粗和非粗体文本片段,则返回 。

getBold(): boolean;

返回

boolean

getColor()

文本颜色 (的 HTML 颜色代码表示形式,例如,“#FF0000”表示红色) 。 null如果 TextRange 包含不同颜色的文本片段,则返回 。

getColor(): string;

返回

string

getItalic()

表示字体的斜体状态。 null如果 TextRange 同时包含斜体和非斜体文本片段,则返回 。

getItalic(): boolean;

返回

boolean

getName()

表示字体名称 (例如“Calibri”) 。 如果文本是复杂脚本或东亚语言,则这是相应的字体名称:否则为拉丁文字体名称。

getName(): string;

返回

string

getSize()

以磅为单位表示字号 (,例如 11) 。 null如果 TextRange 包含具有不同字号的文本片段,则返回 。

getSize(): number;

返回

number

getUnderline()

应用于字体的下划线类型。 null如果 TextRange 包含具有不同下划线样式的文本片段,则返回 。 有关详细信息,请参阅 ExcelScript.ShapeFontUnderlineStyle

getUnderline(): ShapeFontUnderlineStyle;

返回

setBold(bold)

表示字体的加粗状态。 null如果 TextRange 同时包含加粗和非粗体文本片段,则返回 。

setBold(bold: boolean): void;

参数

bold

boolean

返回

void

setColor(color)

文本颜色 (的 HTML 颜色代码表示形式,例如,“#FF0000”表示红色) 。 null如果 TextRange 包含不同颜色的文本片段,则返回 。

setColor(color: string): void;

参数

color

string

返回

void

setItalic(italic)

表示字体的斜体状态。 null如果 TextRange 同时包含斜体和非斜体文本片段,则返回 。

setItalic(italic: boolean): void;

参数

italic

boolean

返回

void

setName(name)

表示字体名称 (例如“Calibri”) 。 如果文本是复杂脚本或东亚语言,则这是相应的字体名称:否则为拉丁文字体名称。

setName(name: string): void;

参数

name

string

返回

void

setSize(size)

以磅为单位表示字号 (,例如 11) 。 null如果 TextRange 包含具有不同字号的文本片段,则返回 。

setSize(size: number): void;

参数

size

number

返回

void

setUnderline(underline)

应用于字体的下划线类型。 null如果 TextRange 包含具有不同下划线样式的文本片段,则返回 。 有关详细信息,请参阅 ExcelScript.ShapeFontUnderlineStyle

setUnderline(underline: ShapeFontUnderlineStyle): void;

参数

返回

void