Excel.ShapeFont class

  • 参考
包:
excel

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

Extends
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.9 ]

属性

bold

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

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

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
italic

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

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

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

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

方法

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)

基于现有的已加载对象，同时对对象设置多个属性。
toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始 Excel.ShapeFont 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ShapeFontData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

bold

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

bold: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.9 ]

color

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

color: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

italic

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

italic: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.9 ]

name

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

name: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

size

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

size: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

underline

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

underline: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";

属性值

Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"

注解

[ API 集：ExcelApi 1.9 ]

方法详细信息

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont;

参数

options
Excel.Interfaces.ShapeFontLoadOptions

提供要加载对象的属性的选项。

返回

Excel.ShapeFont

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.ShapeFont;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.ShapeFont

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ShapeFont;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.ShapeFont

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.ShapeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties
Excel.Interfaces.ShapeFontUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Excel.ShapeFont): void;

参数

properties
Excel.ShapeFont

返回

void

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始 Excel.ShapeFont 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ShapeFontData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.ShapeFontData;

返回

Excel.Interfaces.ShapeFontData