PowerPoint.ShapeFont class

  • 参考
包:
powerpoint

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

Extends
OfficeExtension.ClientObject

注解

[ API 集：PowerPointApi 1.4 ]

属性

bold

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

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

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

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

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

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

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

方法

load(options)

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

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

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

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

属性详细信息

bold

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

bold: boolean;

属性值

boolean

注解

[ API 集：PowerPointApi 1.4 ]

color

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

color: string;

属性值

string

注解

[ API 集：PowerPointApi 1.4 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml

// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
  const textRange = context.presentation.getSelectedTextRange();
  textRange.font.color = "green";
  await context.sync();
});

context

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

context: RequestContext;

属性值

PowerPoint.RequestContext

italic

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

italic: boolean;

属性值

boolean

注解

[ API 集：PowerPointApi 1.4 ]

name

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

name: string;

属性值

string

注解

[ API 集：PowerPointApi 1.4 ]

size

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

size: number;

属性值

number

注解

[ API 集：PowerPointApi 1.4 ]

underline

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

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

属性值

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

注解

[ API 集：PowerPointApi 1.4 ]

方法详细信息

load(options)

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

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

参数

options
PowerPoint.Interfaces.ShapeFontLoadOptions

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

返回

PowerPoint.ShapeFont

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

PowerPoint.ShapeFont

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

PowerPoint.ShapeFont

toJSON()

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

toJSON(): PowerPoint.Interfaces.ShapeFontData;

返回

PowerPoint.Interfaces.ShapeFontData