Word.Font class

フォントをすべての大文字として書式設定するかどうかを指定します。これにより、小文字が大文字として表示されます。 次の値が示される可能性があります。

• true : すべてのテキストに All Caps 属性があります。

• false : すべての Caps 属性を持つテキストはありません。

• null : テキストの一部 (すべてではない) に All Caps 属性がある場合に返されます。

allCaps: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

bold: 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.');
});

フォントを右から左の言語文書で太字で書式設定するかどうかを指定します。 次の値が示される可能性があります。

• true : テキストはすべて太字です。

• false : 太字のテキストはありません。

• null : テキストの一部 (すべてではない) が太字の場合に返されます。

boldBidirectional: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォントのすべての罫線を表す BorderUniversalCollection オブジェクトを返します。

readonly borders: Word.BorderUniversalCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

color: 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.');
});

フォントの色を表す ColorIndex 値を指定します。

colorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

右から左の言語ドキュメントの Font オブジェクトの色を指定します。

colorIndexBidirectional: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

context: RequestContext;

プロパティ値

フォントに対してコンテキスト代替を有効にするかどうかを指定します。

contextualAlternates: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

Font オブジェクトの発音記号に使用する色を指定します。 値は '#RRGGBB' 形式で指定できます。

diacriticColor: string;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

Microsoft Wordが対応するFont オブジェクトの 1 行あたりの文字数を無視するかどうかを指定します。

disableCharacterSpaceGrid: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォントにダブル取り消し線があるかどうかを指定します。 true フォントが二重取り消し線テキストとして書式設定されている場合は 、それ以外の場合は false。

doubleStrikeThrough: boolean;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

フォントをエンボスとして書式設定するかどうかを指定します。 次の値が示される可能性があります。

• true :テキストはすべてエンボス加工されています。

• false : どのテキストもエンボス加工されていません。

• null : テキストの一部がエンボス加工されているが、すべてではない場合に返されます。

emboss: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

文字または指定された文字列の強調マークを表す EmphasisMark 値を指定します。

emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle";

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォントをエングレーブ形式で書式設定するかどうかを指定します。 次の値が示される可能性があります。

• true : すべてのテキストが彫刻されます。

• false : どのテキストもエングレーブされません。

• null : テキストの一部 (すべてではない) が彫刻されている場合に返されます。

engrave: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

テキスト範囲で使用されるフォントの塗りつぶしの書式設定プロパティを含む FillFormat オブジェクトを返します。

readonly fill: Word.FillFormat;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

テキスト範囲で使用されるフォントの光彩書式を表す GlowFormat オブジェクトを返します。

readonly glow: Word.GlowFormat;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

hidden: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.2 ]

強調表示の色を指定します。 これを設定するには、"#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;

プロパティ値

注釈

[ 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.');
});

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

italic: boolean;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

フォントを右から左の言語文書で斜体化するかどうかを指定します。 次の値が示される可能性があります。

• true : すべてのテキストが斜体になっています。

• false : どのテキストも斜体化されていません。

• null : テキストの一部 (すべてではない) が斜体になっている場合に返されます。

italicBidirectional: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

Microsoft Wordがカーニングを自動的に調整する最小フォント サイズを指定します。

kerning: number;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

Font オブジェクトの合字設定を指定します。

ligature: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All";

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

行の書式を指定する LineFormat オブジェクトを返します。

readonly line: Word.LineFormat;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

name: 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.');
});

ラテン文字 (文字コードが 0 (ゼロ) から 127 までの文字) に使用されるフォントを指定します。

nameAscii: string;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

右から左の言語文書のフォント名を指定します。

nameBidirectional: string;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

東アジアのフォント名を指定します。

nameFarEast: string;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

コードが 128 から 255 までの文字に使用されるフォントを指定します。

nameOther: string;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

OpenType フォントの数字の書式設定を指定します。

numberForm: Word.NumberForm | "Default" | "Lining" | "OldStyle";

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォントの間隔の設定を指定します。

numberSpacing: Word.NumberSpacing | "Default" | "Proportional" | "Tabular";

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォントをアウトライン形式で書式設定するかどうかを指定します。 次の値が示される可能性があります。

• true : すべてのテキストのアウトラインが表示されます。

• false : テキストのアウトラインは表示されません。

• null : テキストの一部 (すべてではない) のアウトラインが表示されている場合に返されます。

outline: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

基準線を基準とするテキストの位置をポイント単位で指定します。

position: number;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

図形のリフレクションの書式設定を表す ReflectionFormat オブジェクトを返します。

readonly reflection: Word.ReflectionFormat;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォントに適用されるスケーリング率を指定します。

scaling: number;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォントを影付きとして書式設定するかどうかを指定します。 次の値が示される可能性があります。

• true : すべてのテキストが影付けされます。

• false : どのテキストも影付けされません。

• null : テキストの一部 (すべてではない) に影が付いている場合に返されます。

shadow: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

size: 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.');
});

右から左のテキストのフォント サイズをポイント単位で指定します。

sizeBidirectional: number;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォントを小さい大文字として書式設定するかどうかを指定します。これにより、小文字が小さい大文字として表示されます。 次の値が示される可能性があります。

• true : すべてのテキストに Small Caps 属性があります。

• false : どのテキストにも Small Caps 属性はありません。

• null : テキストの一部 (すべてではない) に Small Caps 属性がある場合に返されます。

smallCaps: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

文字間の間隔を指定します。

spacing: number;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォントに取り消し線があるかどうかを指定します。 true フォントが取り消し線テキストとして書式設定されている場合は 、それ以外の場合は false。

strikeThrough: 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.');
});

フォントのスタイル セットを指定します。

stylisticSet: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20";

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

subscript: boolean;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

フォントが上付き文字かどうかを指定します。 true フォントが上付き文字として書式設定されている場合は 、それ以外の場合は false。

superscript: boolean;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

フォントの色を表す ColorFormat オブジェクトを返します。

readonly textColor: Word.ColorFormat;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォントの影の書式設定を指定する ShadowFormat オブジェクトを返します。

readonly textShadow: Word.ShadowFormat;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォントの 3 次元 (3D) 効果の書式設定プロパティを含む ThreeDimensionalFormat オブジェクトを返します。

readonly threeDimensionalFormat: Word.ThreeDimensionalFormat;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォントの下線の種類を指定します。 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";

プロパティ値

注釈

[ 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.');
});

Font オブジェクトの下線の色を指定します。 値は '#RRGGBB' 形式で指定できます。

underlineColor: string;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

フォント サイズを次に使用可能な大きさまで縮小します。

decreaseFontSize(): void;

戻り値

注釈

[ API set: WordApiDesktop 1.3 ]

選択されている文字列のフォント サイズを、現在のプリンターで使用可能な次の大きさまで拡大します。

increaseFontSize(): void;

戻り値

注釈

[ API set: WordApiDesktop 1.3 ]

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

手動の文字書式を削除します。

reset(): void;

戻り値

注釈

[ API set: WordApiDesktop 1.3 ]

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

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

パラメーター

戻り値

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

set(properties: Word.Font): void;

パラメーター

戻り値

指定されたフォント書式を、作業中の文書および現在使用しているテンプレートを使って作成する新規文書の既定のフォント書式として設定します。

setAsTemplateDefault(): void;

戻り値

注釈

[ API set: WordApiDesktop 1.3 ]

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Word.Font オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.FontData として型指定) を返します。

toJSON(): Word.Interfaces.FontData;

戻り値

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.Font;

戻り値

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。

untrack(): Word.Font;

戻り値