Excel.RangeFont class

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

扩展

注解

[ API 集:ExcelApi 1.1 ]

属性

bold

表示字体的粗体状态。

color

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

context

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

italic

指定字体的斜体状态。

name

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

size

字号

strikethrough

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

subscript

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

superscript

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

tintAndShade

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

underline

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

方法

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.RangeFont对象是 API 对象,toJSON该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.RangeFontData) ,其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

bold

表示字体的粗体状态。

bold: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.1 ]

color

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

color: string;

属性值

string

注解

[ API 集:ExcelApi 1.1 ]

context

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

context: RequestContext;

属性值

italic

指定字体的斜体状态。

italic: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.1 ]

name

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

name: string;

属性值

string

注解

[ API 集:ExcelApi 1.1 ]

示例

// Change the font of the selected range to "Impact".
await Excel.run(async (context) => {
  const selection = context.workbook.getSelectedRange();
  selection.format.font.name = "Impact";
  await context.sync();
});

size

字号

size: number;

属性值

number

注解

[ API 集:ExcelApi 1.1 ]

strikethrough

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

strikethrough: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.9 ]

subscript

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

subscript: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.9 ]

superscript

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

superscript: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.9 ]

tintAndShade

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

tintAndShade: number;

属性值

number

注解

[ API 集:ExcelApi 1.9 ]

underline

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

underline: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";

属性值

Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"

注解

[ API 集:ExcelApi 1.1 ]

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont;

参数

options
Excel.Interfaces.RangeFontLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

示例

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFont = range.format.font;
    rangeFont.load('name');
    await context.sync();
    console.log(rangeFont.name);
});

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

set(properties, options)

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

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

参数

properties
Excel.Interfaces.RangeFontUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.RangeFont): void;

参数

properties
Excel.RangeFont

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.RangeFontData;

返回