Excel.ShapeFont class
表示形状对象的字体属性，如字 TextRange 体名称、字号和颜色。
属性
| bold | 表示字体的加粗状态。 如果同时 |
| color | 文本颜色 (的 HTML 颜色代码表示形式，例如，“#FF0000”表示红色) 。 如果包含 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| italic | 表示字体的斜体状态。 如果同时 |
| name | 表示字体名称 (，例如“Calibri”) 。 如果文本是复杂脚本或东亚语言，则这是相应的字体名称;否则，它是拉丁字体名称。 |
| size | 以磅 (表示字号，例如 11) 。 如果包含 |
| strikethrough | 指定字体的删除线状态。 值表示 |
| subscript | 指定字体的下标状态。 如果区域的所有字体均为下标，则返回 |
| superscript | 指定字体的上标状态。 如果区域的所有字体都是上标，则返回 |
| tint |
指定使区域字体的颜色变亮或变暗的双精度。 该值介于 -1 (最暗) 和 1 (最亮) 之间，其中 0 表示原始颜色。 一个 |
| underline | 应用于字体的下划线类型。 如果包含 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
bold
color
文本颜色 (的 HTML 颜色代码表示形式，例如，“#FF0000”表示红色) 。 如果包含TextRange具有不同颜色的文本片段，则返回null。
color: string;属性值
string
注解
context
italic
name
表示字体名称 (，例如“Calibri”) 。 如果文本是复杂脚本或东亚语言，则这是相应的字体名称;否则，它是拉丁字体名称。
name: string;属性值
string
注解
size
strikethrough
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
指定字体的删除线状态。 值表示 null 整个区域没有统一的删除线设置。
strikethrough: boolean;属性值
boolean
注解
subscript
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
指定字体的下标状态。 如果区域的所有字体均为下标，则返回 true 。 如果区域的所有字体均为上标或普通字体 (既不是上标字体也不是下标) ，则返回 false 。 否则返回 null 。
subscript: boolean;属性值
boolean
注解
superscript
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
指定字体的上标状态。 如果区域的所有字体都是上标，则返回 true 。 如果区域的所有字体均为下标或普通字体， (既不上标也不为下标) ，则返回 false 。 否则返回 null 。
superscript: boolean;属性值
boolean
注解
tintAndShade
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
指定使区域字体的颜色变亮或变暗的双精度。 该值介于 -1 (最暗) 和 1 (最亮) 之间，其中 0 表示原始颜色。 一个 null 值指示整个区域没有统一的字体 tintAndShade 设置。
tintAndShade: number;属性值
number
注解
underline
应用于字体的下划线类型。 如果包含TextRange具有不同下划线样式的文本片段，则返回null。 有关详细信息，请参阅 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"
注解
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.ShapeFont;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ShapeFont;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
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;