Word.Font class

参考

包:: word

表示字体。

Extends: OfficeExtension.ClientObject

注解

属性

bold	指定一个值，该值指示字体是否为粗体。如果字体格式为粗体则为 true，否则为 false。
color	指定指定字体的颜色。可以采用“#RRGGBB”格式或颜色名称提供值。
context	与对象关联的请求上下文。这会将加载项的进程连接到 Office 主机应用程序的进程。
doubleStrikeThrough	指定一个值，该值指示字体是否具有双删除线。如果字体格式设置为加双删除线的文本则为 true，否则为 false。
hidden	指定一个值，该值指示字体是否标记为隐藏。如果字体的格式设置为隐藏文本，则为 True;否则为 false。
highlightColor	指定突出显示颜色。若要设置它，请使用“#RRGGBB”格式或颜色名称的值。若要删除突出显示颜色，请将其设置为 null。返回的突出显示颜色可以是“#RRGGBB”格式，混合突出显示颜色的空字符串，或 null 表示无突出显示颜色。注意：Office for Windows Desktop 中只有默认突出显示颜色可用。这些是“黄色”、“石灰”、“绿松石”、“粉色”、“蓝色”、“红色”、“深蓝色”、“青青”、“绿色”、“紫色”、“深红”、“橄榄”、“灰色”、“LightGray”和“黑色”。当加载项在 Office for Windows 桌面版中运行时，任何其他颜色在应用于字体时将转换为最接近的颜色。
italic	指定一个值，该值指示字体是否斜体。如果字体为斜体则为 true，否则为 false。
name	指定表示字体名称的值。
size	指定一个值，该值表示字号（以磅为单位）。
strikeThrough	指定一个值，该值指示字体是否具有删除线。如果字体格式设置为加删除线的文本则为 true，否则为 false。
subscript	指定一个值，该值指示字体是否为下标。如果字体格式为下标则为 true，否则为 false。
superscript	指定一个值，该值指示字体是否为上标。如果字体格式为上标则为 true，否则为 false。
underline	指定一个值，该值指示字体的下划线类型。如果字体没有下划线，则为“无”。

方法

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`传递给它的对象的方法。) 而原始Word。Font 对象是一个 API 对象，`toJSON`该方法返回一个纯 JavaScript 对象， (类型化为 `Word.Interfaces.FontData`) ，其中包含原始对象中加载的任何子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果跨 `.sync` 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。如果此对象是集合的一部分，则还应跟踪父集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。在内存发布生效之前，需要调用 `context.sync()` 。

属性详细信息

bold

指定一个值，该值指示字体是否为粗体。如果字体格式为粗体则为 true，否则为 false。

bold: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.1 ]

示例

// Bold format text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to make the current selection bold.
    selection.font.bold = true;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection is now bold.');
});

color

指定指定字体的颜色。可以采用“#RRGGBB”格式或颜色名称提供值。

color: string;

属性值

string

注解

[ API 集：WordApi 1.1 ]

示例

// Change the font color
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the font color of the current selection.
    selection.font.color = 'blue';

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font color of the selection has been changed.');
});

context

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

context: RequestContext;

属性值

Word.RequestContext

doubleStrikeThrough

指定一个值，该值指示字体是否具有双删除线。如果字体格式设置为加双删除线的文本则为 true，否则为 false。

doubleStrikeThrough: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.1 ]

hidden

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

指定一个值，该值指示字体是否标记为隐藏。如果字体的格式设置为隐藏文本，则为 True;否则为 false。

hidden: boolean;

属性值

boolean

注解

[ API 集：WordApi BETA (仅预览版) ]

highlightColor

指定突出显示颜色。若要设置它，请使用“#RRGGBB”格式或颜色名称的值。若要删除突出显示颜色，请将其设置为 null。返回的突出显示颜色可以是“#RRGGBB”格式，混合突出显示颜色的空字符串，或 null 表示无突出显示颜色。注意：Office for Windows Desktop 中只有默认突出显示颜色可用。这些是“黄色”、“石灰”、“绿松石”、“粉色”、“蓝色”、“红色”、“深蓝色”、“青青”、“绿色”、“紫色”、“深红”、“橄榄”、“灰色”、“LightGray”和“黑色”。当加载项在 Office for Windows 桌面版中运行时，任何其他颜色在应用于字体时将转换为最接近的颜色。

highlightColor: string;

属性值

string

注解

[ API 集：WordApi 1.1 ]

示例

// Highlight selected text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to highlight the current selection.
    selection.font.highlightColor = '#FFFF00'; // Yellow

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection has been highlighted.');
});

italic

指定一个值，该值指示字体是否斜体。如果字体为斜体则为 true，否则为 false。

italic: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.1 ]

name

指定表示字体名称的值。

name: string;

属性值

string

注解

[ API 集：WordApi 1.1 ]

示例

// Change the font name
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the current selection's font name.
    selection.font.name = 'Arial';

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font name has changed.');
});

size

指定一个值，该值表示字号（以磅为单位）。

size: number;

属性值

number

注解

[ API 集：WordApi 1.1 ]

示例

// Change the font size
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the current selection's font size.
    selection.font.size = 20;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font size has changed.');
});

strikeThrough

指定一个值，该值指示字体是否具有删除线。如果字体格式设置为加删除线的文本则为 true，否则为 false。

strikeThrough: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.1 ]

示例

// Strike format text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to strikethrough the font of the current selection.
    selection.font.strikeThrough = true;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection now has a strikethrough.');
});

subscript

指定一个值，该值指示字体是否为下标。如果字体格式为下标则为 true，否则为 false。

subscript: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.1 ]

superscript

指定一个值，该值指示字体是否为上标。如果字体格式为上标则为 true，否则为 false。

superscript: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.1 ]

underline

指定一个值，该值指示字体的下划线类型。如果字体没有下划线，则为“无”。

underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";

属性值

注解

[ API 集：WordApi 1.1 ]

示例

// Underline format text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to underline the current selection.
    selection.font.underline = Word.UnderlineType.single;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection now has an underline style.');
});

方法详细信息

load(options)

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

load(options?: Word.Interfaces.FontLoadOptions): Word.Font;

参数

options: Word.Interfaces.FontLoadOptions

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

Word.Font

load(propertyNames)

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

load(propertyNames?: string | string[]): Word.Font;

参数

propertyNames: string | string[]

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

Word.Font

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Font;

参数

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

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

Word.Font

set(properties, options)

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

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

参数

properties: Word.Interfaces.FontUpdateData

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

options: OfficeExtension.UpdateOptions

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

void

set(properties)

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

set(properties: Word.Font): void;

参数

properties: Word.Font

void

toJSON()

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

toJSON(): Word.Interfaces.FontData;

Word.Interfaces.FontData

track()

根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.Font;

Word.Font

untrack()

释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.Font;

Word.Font

Word.Font class

注解

属性

方法

属性详细信息

bold

属性值

注解

示例

color

属性值

注解

示例

context

属性值

doubleStrikeThrough

属性值

注解

hidden

属性值

注解

highlightColor

属性值

注解

示例

italic

属性值

注解

name

属性值

注解

示例

size

属性值

注解

示例

strikeThrough

属性值

注解

示例

subscript

属性值

注解

superscript

属性值

注解

underline

属性值

注解

示例

方法详细信息

load(options)

参数

返回

load(propertyNames)

参数

返回

load(propertyNamesAndPaths)

参数

返回

set(properties, options)

参数

返回

set(properties)

参数

返回

toJSON()

返回

track()

返回

untrack()

返回

反馈

其他资源