Word.Font class

  • リファレンス
パッケージ:
word

フォントを表します。

Extends
OfficeExtension.ClientObject

注釈

[ API セット: WordApi 1.1 ]

プロパティ

bold

フォントが太字かどうかを示す値を指定します。 フォントの書式設定が太字の場合は true、それ以外の場合は false です。
color

指定したフォントの色を指定します。 値は、"#RRGGBB" 形式または色名で指定できます。
context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
doubleStrikeThrough

フォントにダブル取り消し線があるかどうかを示す値を指定します。 フォントの書式が二重取り消し線付きのテキストである場合は true、それ以外の場合は false です。
hidden

フォントが非表示としてタグ付けされているかどうかを示す値を指定します。 True のフォントが非表示のテキストとして書式設定されている場合は、それ以外の場合は false。
highlightColor

強調表示の色を指定します。 これを設定するには、"#RRGGBB" 形式または色名のいずれかの値を使用します。 強調表示の色を削除するには、null に設定します。 返される強調表示の色は、'#RRGGBB' 形式、混合強調表示色の場合は空の文字列、強調表示色がない場合は null にすることができます。 注: Office for Windows Desktop では、既定の強調表示色のみを使用できます。 これらは"Yellow"、"Lime"、"Turquoise"、"Pink"、"Blue"、"Red"、"DarkBlue"、"Teal"、"Green"、"Purple"、"DarkRed"、"Olive"、"Gray"、"LightGray"、"Black" です。 アドインが Office for Windows Desktop で実行されると、フォントに適用されると、その他の色が最も近い色に変換されます。
italic

フォントが斜体かどうかを示す値を指定します。 フォントが斜体の場合は true、それ以外の場合は false です。
name

フォントの名前を表す値を指定します。
size

フォント サイズをポイント単位で表す値を指定します。
strikeThrough

フォントに取り消し線があるかどうかを示す値を指定します。 フォントの書式が取り消し線付きのテキストである場合は true、それ以外の場合は false です。
subscript

フォントが添字であるかどうかを示す値を指定します。 フォントの書式が下付き文字である場合は true、それ以外の場合は false です。
superscript

フォントが上付き文字であるかどうかを示す値を指定します。 フォントの書式が上付き文字である場合は true、それ以外の場合は false です。
underline

フォントの下線の種類を示す値を指定します。 フォントに下線が付いていない場合は 、'None' です。

メソッド

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()

API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを 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 では、既定の強調表示色のみを使用できます。 これらは"Yellow"、"Lime"、"Turquoise"、"Pink"、"Blue"、"Red"、"DarkBlue"、"Teal"、"Green"、"Purple"、"DarkRed"、"Olive"、"Gray"、"LightGray"、"Black" です。 アドインが Office for Windows Desktop で実行されると、フォントに適用されると、その他の色が最も近い色に変換されます。

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

フォントの下線の種類を示す値を指定します。 フォントに下線が付いていない場合は 、'None' です。

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

プロパティ値

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()

API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを 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